blob: 2a12ac8f0567fa79acd06ca6f0b247a647505f5f [file] [log] [blame]
Dianne Hackbornd6847842010-01-12 18:14:19 -08001/*
2 * Copyright (C) 2010 The Android Open Source Project
3 *
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
7 *
8 * http://www.apache.org/licenses/LICENSE-2.0
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 */
16
Dianne Hackborn87bba1e2010-02-26 17:25:54 -080017package android.app.admin;
Dianne Hackbornd6847842010-01-12 18:14:19 -080018
Nicolas Prevot8f7698a2016-02-11 16:05:33 +000019import android.annotation.ColorInt;
Alan Treadwayafad8782016-01-19 15:15:08 +000020import android.annotation.IntDef;
Robin Lee25e26452015-06-02 09:56:29 -070021import android.annotation.NonNull;
22import android.annotation.Nullable;
Dianne Hackbornd6847842010-01-12 18:14:19 -080023import android.annotation.SdkConstant;
24import android.annotation.SdkConstant.SdkConstantType;
Justin Moreyb5deda72014-07-24 10:53:40 -050025import android.annotation.SystemApi;
Nicolas Prevot8f7698a2016-02-11 16:05:33 +000026import android.annotation.UserIdInt;
Jason Monkd7b86212014-06-16 13:15:38 -040027import android.app.Activity;
Michal Karpinski6235a942016-03-15 12:07:23 +000028import android.app.admin.SecurityLog.SecurityEvent;
Dianne Hackbornd6847842010-01-12 18:14:19 -080029import android.content.ComponentName;
30import android.content.Context;
Adam Connors010cfd42014-04-16 12:48:13 +010031import android.content.Intent;
Sander Alewijnsef475ca32014-02-17 15:13:58 +000032import android.content.IntentFilter;
Dianne Hackbornd6847842010-01-12 18:14:19 -080033import android.content.pm.PackageManager;
Victor Changcd14c0a2016-03-16 19:10:15 +000034import android.content.pm.PackageManager.NameNotFoundException;
Rubin Xuc3cd05f2016-01-11 12:11:35 +000035import android.content.pm.ParceledListSlice;
Sudheer Shanka978fc0d2016-01-28 13:51:10 +000036import android.content.pm.UserInfo;
Julia Reynoldsfca04ca2015-02-17 13:39:12 -050037import android.graphics.Bitmap;
Jason Monk03bc9912014-05-13 09:44:57 -040038import android.net.ProxyInfo;
Nicolas Prevot8b7991c2015-11-12 17:40:12 +000039import android.net.Uri;
Robin Lee66e5d962014-04-09 16:44:21 +010040import android.os.Bundle;
Jim Millere303bf42014-08-26 17:12:29 -070041import android.os.PersistableBundle;
Adam Connors776c5552014-01-09 10:42:56 +000042import android.os.Process;
Dianne Hackborn8ea138c2010-01-26 18:01:04 -080043import android.os.RemoteCallback;
Dianne Hackbornd6847842010-01-12 18:14:19 -080044import android.os.RemoteException;
45import android.os.ServiceManager;
Amith Yamasani599dd7c2012-09-14 23:20:08 -070046import android.os.UserHandle;
Julia Reynolds1e958392014-05-16 14:25:21 -040047import android.os.UserManager;
Ricky Wai494b95d2015-11-20 16:07:15 +000048import android.provider.ContactsContract.Directory;
Mahaver Chopra1ce53bc2015-12-14 13:35:14 +000049import android.provider.Settings;
Bernhard Bauer26408cc2014-09-08 14:07:31 +010050import android.security.Credentials;
Amith Yamasanid1d7c022014-08-19 17:03:41 -070051import android.service.restrictions.RestrictionsReceiver;
Mahaver Chopra1216ae52016-03-11 15:39:48 +000052import android.telephony.TelephonyManager;
Dianne Hackbornd6847842010-01-12 18:14:19 -080053import android.util.Log;
54
Makoto Onukicc4bbeb2015-09-17 10:28:24 -070055import com.android.internal.annotations.VisibleForTesting;
Maggie Benthallda51e682013-08-08 22:35:44 -040056import com.android.org.conscrypt.TrustedCertificateStore;
57
58import java.io.ByteArrayInputStream;
Dianne Hackbornd6847842010-01-12 18:14:19 -080059import java.io.IOException;
Alan Treadwayafad8782016-01-19 15:15:08 +000060import java.lang.annotation.Retention;
61import java.lang.annotation.RetentionPolicy;
Oscar Montemayor69238c62010-08-03 10:51:06 -070062import java.net.InetSocketAddress;
63import java.net.Proxy;
Robin Lee0d5ccb72014-09-12 17:41:44 +010064import java.security.KeyFactory;
Mahaver Chopra1ce53bc2015-12-14 13:35:14 +000065import java.security.NoSuchAlgorithmException;
Bernhard Bauer26408cc2014-09-08 14:07:31 +010066import java.security.PrivateKey;
67import java.security.cert.Certificate;
Maggie Benthallda51e682013-08-08 22:35:44 -040068import java.security.cert.CertificateException;
69import java.security.cert.CertificateFactory;
70import java.security.cert.X509Certificate;
Robin Lee0d5ccb72014-09-12 17:41:44 +010071import java.security.spec.InvalidKeySpecException;
Mahaver Chopra1ce53bc2015-12-14 13:35:14 +000072import java.security.spec.PKCS8EncodedKeySpec;
Jim Miller604e7552014-07-18 19:00:02 -070073import java.util.ArrayList;
Rubin Xub4365912016-03-23 12:13:22 +000074import java.util.Arrays;
Svetoslav976e8bd2014-07-16 15:12:03 -070075import java.util.Collections;
Dianne Hackbornd47c6ed2010-01-27 16:21:20 -080076import java.util.List;
Bartosz Fabianowski4c052f22016-01-25 14:18:43 +010077import java.util.Set;
Dianne Hackbornd6847842010-01-12 18:14:19 -080078
79/**
Alexandra Gherghina541afcd2014-11-07 11:18:12 +000080 * Public interface for managing policies enforced on a device. Most clients of this class must be
Suprabh Shukla34d92ef2016-03-14 13:49:37 -070081 * registered with the system as a <a href="{@docRoot}guide/topics/admin/device-admin.html">device
82 * administrator</a>. Additionally, a device administrator may be registered as either a profile or
83 * device owner. A given method is accessible to all device administrators unless the documentation
84 * for that method specifies that it is restricted to either device or profile owners. Any
85 * application calling an api may only pass as an argument a device administrator component it
86 * owns. Otherwise, a {@link SecurityException} will be thrown.
Joe Fernandez3aef8e1d2011-12-20 10:38:34 -080087 * <div class="special reference">
88 * <h3>Developer Guides</h3>
Suprabh Shukla34d92ef2016-03-14 13:49:37 -070089 * <p>
90 * For more information about managing policies for device administration, read the <a href=
91 * "{@docRoot}guide/topics/admin/device-admin.html">Device Administration</a> developer
92 * guide. </div>
Dianne Hackbornd6847842010-01-12 18:14:19 -080093 */
94public class DevicePolicyManager {
95 private static String TAG = "DevicePolicyManager";
Dianne Hackbornd6847842010-01-12 18:14:19 -080096
97 private final Context mContext;
Dianne Hackbornd6847842010-01-12 18:14:19 -080098 private final IDevicePolicyManager mService;
Esteban Talavera62399912016-01-11 15:37:55 +000099 private final boolean mParentInstance;
Konstantin Lopyrev32558232010-05-20 16:18:05 -0700100
Clara Bayarri3e826ef2015-12-14 17:51:22 +0000101 private DevicePolicyManager(Context context, boolean parentInstance) {
Esteban Talavera62399912016-01-11 15:37:55 +0000102 this(context,
103 IDevicePolicyManager.Stub.asInterface(
104 ServiceManager.getService(Context.DEVICE_POLICY_SERVICE)),
105 parentInstance);
Dianne Hackbornd6847842010-01-12 18:14:19 -0800106 }
107
Dianne Hackborn87bba1e2010-02-26 17:25:54 -0800108 /** @hide */
Makoto Onukicc4bbeb2015-09-17 10:28:24 -0700109 @VisibleForTesting
Esteban Talavera62399912016-01-11 15:37:55 +0000110 protected DevicePolicyManager(
111 Context context, IDevicePolicyManager service, boolean parentInstance) {
Makoto Onukicc4bbeb2015-09-17 10:28:24 -0700112 mContext = context;
113 mService = service;
Esteban Talavera62399912016-01-11 15:37:55 +0000114 mParentInstance = parentInstance;
Makoto Onukicc4bbeb2015-09-17 10:28:24 -0700115 }
116
117 /** @hide */
118 public static DevicePolicyManager create(Context context) {
Clara Bayarri3e826ef2015-12-14 17:51:22 +0000119 DevicePolicyManager me = new DevicePolicyManager(context, false);
Dianne Hackborn21f1bd12010-02-19 17:02:21 -0800120 return me.mService != null ? me : null;
121 }
Konstantin Lopyrev32558232010-05-20 16:18:05 -0700122
Makoto Onukicc4bbeb2015-09-17 10:28:24 -0700123 /** @hide test will override it. */
124 @VisibleForTesting
125 protected int myUserId() {
126 return UserHandle.myUserId();
127 }
128
Dianne Hackbornd6847842010-01-12 18:14:19 -0800129 /**
Jessica Hummelf72078b2014-03-06 16:13:12 +0000130 * Activity action: Starts the provisioning flow which sets up a managed profile.
Jessica Hummelf72078b2014-03-06 16:13:12 +0000131 *
Jessica Hummel9da60392014-05-21 12:32:57 +0100132 * <p>A managed profile allows data separation for example for the usage of a
133 * device as a personal and corporate device. The user which provisioning is started from and
134 * the managed profile share a launcher.
135 *
Andrew Solovay27f53372015-03-02 16:37:59 -0800136 * <p>This intent will typically be sent by a mobile device management application (MDM).
137 * Provisioning adds a managed profile and sets the MDM as the profile owner who has full
138 * control over the profile.
Jessica Hummel9da60392014-05-21 12:32:57 +0100139 *
Alan Treadway46dd4492015-11-09 13:57:19 +0000140 * <p>It is possible to check if provisioning is allowed or not by querying the method
141 * {@link #isProvisioningAllowed(String)}.
142 *
143 * <p>In version {@link android.os.Build.VERSION_CODES#LOLLIPOP}, this intent must contain the
Nicolas Prevot18440252015-03-09 14:07:17 +0000144 * extra {@link #EXTRA_PROVISIONING_DEVICE_ADMIN_PACKAGE_NAME}.
Dianne Hackborn0e3de6c2015-07-29 15:20:21 -0700145 * As of {@link android.os.Build.VERSION_CODES#M}, it should contain the extra
Nicolas Prevot18440252015-03-09 14:07:17 +0000146 * {@link #EXTRA_PROVISIONING_DEVICE_ADMIN_COMPONENT_NAME} instead, although specifying only
147 * {@link #EXTRA_PROVISIONING_DEVICE_ADMIN_PACKAGE_NAME} is still supported.
Nicolas Prevotcaf11cd2015-11-19 10:58:35 +0000148 *
Benjamin Franzea956242016-03-21 15:45:56 +0000149 * <p>The intent may also contain the following extras:
Nicolas Prevotcaf11cd2015-11-19 10:58:35 +0000150 * <ul>
Benjamin Franzea956242016-03-21 15:45:56 +0000151 * <li>{@link #EXTRA_PROVISIONING_ACCOUNT_TO_MIGRATE}, optional </li>
152 * <li>{@link #EXTRA_PROVISIONING_SKIP_ENCRYPTION}, optional, supported from
153 * {@link android.os.Build.VERSION_CODES#N}</li>
154 * <li>{@link #EXTRA_PROVISIONING_ADMIN_EXTRAS_BUNDLE}, optional</li>
155 * <li>{@link #EXTRA_PROVISIONING_LOGO_URI}, optional</li>
156 * <li>{@link #EXTRA_PROVISIONING_MAIN_COLOR}, optional</li>
Nicolas Prevotcaf11cd2015-11-19 10:58:35 +0000157 * </ul>
Jessica Hummelf72078b2014-03-06 16:13:12 +0000158 *
Benjamin Franzea956242016-03-21 15:45:56 +0000159 * <p>When managed provisioning has completed, broadcasts are sent to the application specified
Alexandra Gherghinadb4bc572015-01-08 12:17:40 +0000160 * in the provisioning intent. The
161 * {@link DeviceAdminReceiver#ACTION_PROFILE_PROVISIONING_COMPLETE} broadcast is sent in the
162 * managed profile and the {@link #ACTION_MANAGED_PROFILE_PROVISIONED} broadcast is sent in
163 * the primary profile.
Jessica Hummel9da60392014-05-21 12:32:57 +0100164 *
Benjamin Franzea956242016-03-21 15:45:56 +0000165 * <p>If provisioning fails, the managedProfile is removed so the device returns to its
Sander Alewijnse1cc4ecc2014-06-23 19:56:52 +0100166 * previous state.
Alan Treadway4582f812015-07-28 11:49:35 +0100167 *
168 * <p>If launched with {@link android.app.Activity#startActivityForResult(Intent, int)} a
169 * result code of {@link android.app.Activity#RESULT_OK} implies that the synchronous part of
170 * the provisioning flow was successful, although this doesn't guarantee the full flow will
171 * succeed. Conversely a result code of {@link android.app.Activity#RESULT_CANCELED} implies
172 * that the user backed-out of provisioning, or some precondition for provisioning wasn't met.
Jessica Hummelf72078b2014-03-06 16:13:12 +0000173 */
174 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
175 public static final String ACTION_PROVISION_MANAGED_PROFILE
Esteban Talaveraef9c5232014-09-08 13:51:18 +0100176 = "android.app.action.PROVISION_MANAGED_PROFILE";
Jessica Hummelf72078b2014-03-06 16:13:12 +0000177
178 /**
Mahaver Chopra7830daa2015-11-10 18:12:43 +0000179 * Activity action: Starts the provisioning flow which sets up a managed user.
180 *
181 * <p>This intent will typically be sent by a mobile device management application (MDM).
Makoto Onuki32b30572015-12-11 14:29:51 -0800182 * Provisioning configures the user as managed user and sets the MDM as the profile
Mahaver Chopra7830daa2015-11-10 18:12:43 +0000183 * owner who has full control over the user. Provisioning can only happen before user setup has
184 * been completed. Use {@link #isProvisioningAllowed(String)} to check if provisioning is
185 * allowed.
186 *
Benjamin Franzea956242016-03-21 15:45:56 +0000187 * <p>The intent contains the following extras:
188 * <ul>
189 * <li>{@link #EXTRA_PROVISIONING_DEVICE_ADMIN_COMPONENT_NAME}</li>
190 * <li>{@link #EXTRA_PROVISIONING_SKIP_ENCRYPTION}, optional</li>
191 * <li>{@link #EXTRA_PROVISIONING_ADMIN_EXTRAS_BUNDLE}, optional</li>
192 * <li>{@link #EXTRA_PROVISIONING_LOGO_URI}, optional</li>
193 * <li>{@link #EXTRA_PROVISIONING_MAIN_COLOR}, optional</li>
194 * </ul>
Mahaver Chopra7830daa2015-11-10 18:12:43 +0000195 *
Benjamin Franzea956242016-03-21 15:45:56 +0000196 * <p>If provisioning fails, the device returns to its previous state.
Mahaver Chopra7830daa2015-11-10 18:12:43 +0000197 *
198 * <p>If launched with {@link android.app.Activity#startActivityForResult(Intent, int)} a
199 * result code of {@link android.app.Activity#RESULT_OK} implies that the synchronous part of
200 * the provisioning flow was successful, although this doesn't guarantee the full flow will
201 * succeed. Conversely a result code of {@link android.app.Activity#RESULT_CANCELED} implies
202 * that the user backed-out of provisioning, or some precondition for provisioning wasn't met.
Benjamin Franzea956242016-03-21 15:45:56 +0000203 *
204 * @hide
Mahaver Chopra5e732562015-11-05 11:55:12 +0000205 */
206 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
207 public static final String ACTION_PROVISION_MANAGED_USER
208 = "android.app.action.PROVISION_MANAGED_USER";
209
210 /**
Nicolas Prevot64bf7b22015-04-29 14:43:49 +0100211 * Activity action: Starts the provisioning flow which sets up a managed device.
212 * Must be started with {@link android.app.Activity#startActivityForResult(Intent, int)}.
213 *
214 * <p> During device owner provisioning a device admin app is set as the owner of the device.
215 * A device owner has full control over the device. The device owner can not be modified by the
216 * user.
217 *
218 * <p> A typical use case would be a device that is owned by a company, but used by either an
219 * employee or client.
220 *
221 * <p> An intent with this action can be sent only on an unprovisioned device.
Alan Treadway46dd4492015-11-09 13:57:19 +0000222 * It is possible to check if provisioning is allowed or not by querying the method
223 * {@link #isProvisioningAllowed(String)}.
Nicolas Prevot64bf7b22015-04-29 14:43:49 +0100224 *
Alan Treadway46dd4492015-11-09 13:57:19 +0000225 * <p>The intent contains the following extras:
Nicolas Prevot64bf7b22015-04-29 14:43:49 +0100226 * <ul>
227 * <li>{@link #EXTRA_PROVISIONING_DEVICE_ADMIN_COMPONENT_NAME}</li>
228 * <li>{@link #EXTRA_PROVISIONING_SKIP_ENCRYPTION}, optional</li>
229 * <li>{@link #EXTRA_PROVISIONING_LEAVE_ALL_SYSTEM_APPS_ENABLED}, optional</li>
Rubin Xua4f9dc12015-06-12 13:27:59 +0100230 * <li>{@link #EXTRA_PROVISIONING_ADMIN_EXTRAS_BUNDLE}, optional</li>
Nicolas Prevot8b7991c2015-11-12 17:40:12 +0000231 * <li>{@link #EXTRA_PROVISIONING_LOGO_URI}, optional</li>
Nicolas Prevotcaf11cd2015-11-19 10:58:35 +0000232 * <li>{@link #EXTRA_PROVISIONING_MAIN_COLOR}, optional</li>
Nicolas Prevot64bf7b22015-04-29 14:43:49 +0100233 * </ul>
234 *
Benjamin Franzea956242016-03-21 15:45:56 +0000235 * <p>When device owner provisioning has completed, an intent of the type
Nicolas Prevot64bf7b22015-04-29 14:43:49 +0100236 * {@link DeviceAdminReceiver#ACTION_PROFILE_PROVISIONING_COMPLETE} is broadcast to the
237 * device owner.
238 *
Benjamin Franzea956242016-03-21 15:45:56 +0000239 * <p>If provisioning fails, the device is factory reset.
Nicolas Prevot64bf7b22015-04-29 14:43:49 +0100240 *
Alan Treadway4582f812015-07-28 11:49:35 +0100241 * <p>A result code of {@link android.app.Activity#RESULT_OK} implies that the synchronous part
242 * of the provisioning flow was successful, although this doesn't guarantee the full flow will
243 * succeed. Conversely a result code of {@link android.app.Activity#RESULT_CANCELED} implies
244 * that the user backed-out of provisioning, or some precondition for provisioning wasn't met.
Nicolas Prevot64bf7b22015-04-29 14:43:49 +0100245 */
246 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
247 public static final String ACTION_PROVISION_MANAGED_DEVICE
248 = "android.app.action.PROVISION_MANAGED_DEVICE";
249
250 /**
Alan Treadway46dd4492015-11-09 13:57:19 +0000251 * Activity action: Starts the provisioning flow which sets up a managed device.
Steven Ng980a1b62016-02-02 17:43:18 +0000252 *
253 * <p>During device owner provisioning, a device admin app is downloaded and set as the owner of
254 * the device. A device owner has full control over the device. The device owner can not be
255 * modified by the user and the only way of resetting the device is via factory reset.
256 *
257 * <p>A typical use case would be a device that is owned by a company, but used by either an
258 * employee or client.
259 *
260 * <p>The provisioning message should be sent to an unprovisioned device.
261 *
262 * <p>Unlike {@link #ACTION_PROVISION_MANAGED_DEVICE}, the provisioning message can only be sent
263 * by a privileged app with the permission
264 * {@link android.Manifest.permission#DISPATCH_PROVISIONING_MESSAGE}.
265 *
266 * <p>The provisioning intent contains the following properties:
267 * <ul>
268 * <li>{@link #EXTRA_PROVISIONING_DEVICE_ADMIN_COMPONENT_NAME}</li>
269 * <li>{@link #EXTRA_PROVISIONING_DEVICE_ADMIN_PACKAGE_DOWNLOAD_LOCATION}, optional</li>
270 * <li>{@link #EXTRA_PROVISIONING_DEVICE_ADMIN_PACKAGE_DOWNLOAD_COOKIE_HEADER}, optional</li>
271 * <li>{@link #EXTRA_PROVISIONING_DEVICE_ADMIN_PACKAGE_CHECKSUM}, optional</li>
272 * <li>{@link #EXTRA_PROVISIONING_LOCAL_TIME} (convert to String), optional</li>
273 * <li>{@link #EXTRA_PROVISIONING_TIME_ZONE}, optional</li>
274 * <li>{@link #EXTRA_PROVISIONING_LOCALE}, optional</li>
275 * <li>{@link #EXTRA_PROVISIONING_WIFI_SSID}, optional</li>
276 * <li>{@link #EXTRA_PROVISIONING_WIFI_HIDDEN} (convert to String), optional</li>
277 * <li>{@link #EXTRA_PROVISIONING_WIFI_SECURITY_TYPE}, optional</li>
278 * <li>{@link #EXTRA_PROVISIONING_WIFI_PASSWORD}, optional</li>
279 * <li>{@link #EXTRA_PROVISIONING_WIFI_PROXY_HOST}, optional</li>
280 * <li>{@link #EXTRA_PROVISIONING_WIFI_PROXY_PORT} (convert to String), optional</li>
281 * <li>{@link #EXTRA_PROVISIONING_WIFI_PROXY_BYPASS}, optional</li>
282 * <li>{@link #EXTRA_PROVISIONING_WIFI_PAC_URL}, optional</li>
283 * <li>{@link #EXTRA_PROVISIONING_ADMIN_EXTRAS_BUNDLE}, optional</li></ul>
284 *
285 * @hide
286 */
287 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
288 @SystemApi
289 public static final String ACTION_PROVISION_MANAGED_DEVICE_FROM_TRUSTED_SOURCE =
290 "android.app.action.PROVISION_MANAGED_DEVICE_FROM_TRUSTED_SOURCE";
291
292 /**
293 * Activity action: Starts the provisioning flow which sets up a managed device.
Alan Treadway46dd4492015-11-09 13:57:19 +0000294 * Must be started with {@link android.app.Activity#startActivityForResult(Intent, int)}.
295 *
296 * <p>NOTE: This is only supported on split system user devices, and puts the device into a
297 * management state that is distinct from that reached by
298 * {@link #ACTION_PROVISION_MANAGED_DEVICE} - specifically the device owner runs on the system
299 * user, and only has control over device-wide policies, not individual users and their data.
300 * The primary benefit is that multiple non-system users are supported when provisioning using
301 * this form of device management.
302 *
Benjamin Franzea956242016-03-21 15:45:56 +0000303 * <p>During device owner provisioning a device admin app is set as the owner of the device.
Alan Treadway46dd4492015-11-09 13:57:19 +0000304 * A device owner has full control over the device. The device owner can not be modified by the
305 * user.
306 *
Benjamin Franzea956242016-03-21 15:45:56 +0000307 * <p>A typical use case would be a device that is owned by a company, but used by either an
Alan Treadway46dd4492015-11-09 13:57:19 +0000308 * employee or client.
309 *
Benjamin Franzea956242016-03-21 15:45:56 +0000310 * <p>An intent with this action can be sent only on an unprovisioned device.
Alan Treadway46dd4492015-11-09 13:57:19 +0000311 * It is possible to check if provisioning is allowed or not by querying the method
312 * {@link #isProvisioningAllowed(String)}.
313 *
314 * <p>The intent contains the following extras:
315 * <ul>
316 * <li>{@link #EXTRA_PROVISIONING_DEVICE_ADMIN_COMPONENT_NAME}</li>
317 * <li>{@link #EXTRA_PROVISIONING_SKIP_ENCRYPTION}, optional</li>
318 * <li>{@link #EXTRA_PROVISIONING_LEAVE_ALL_SYSTEM_APPS_ENABLED}, optional</li>
319 * <li>{@link #EXTRA_PROVISIONING_ADMIN_EXTRAS_BUNDLE}, optional</li>
Benjamin Franzea956242016-03-21 15:45:56 +0000320 * <li>{@link #EXTRA_PROVISIONING_LOGO_URI}, optional</li>
321 * <li>{@link #EXTRA_PROVISIONING_MAIN_COLOR}, optional</li>
Alan Treadway46dd4492015-11-09 13:57:19 +0000322 * </ul>
323 *
Benjamin Franzea956242016-03-21 15:45:56 +0000324 * <p>When device owner provisioning has completed, an intent of the type
Alan Treadway46dd4492015-11-09 13:57:19 +0000325 * {@link DeviceAdminReceiver#ACTION_PROFILE_PROVISIONING_COMPLETE} is broadcast to the
326 * device owner.
327 *
Benjamin Franzea956242016-03-21 15:45:56 +0000328 * <p>If provisioning fails, the device is factory reset.
Alan Treadway46dd4492015-11-09 13:57:19 +0000329 *
330 * <p>A result code of {@link android.app.Activity#RESULT_OK} implies that the synchronous part
331 * of the provisioning flow was successful, although this doesn't guarantee the full flow will
332 * succeed. Conversely a result code of {@link android.app.Activity#RESULT_CANCELED} implies
333 * that the user backed-out of provisioning, or some precondition for provisioning wasn't met.
334 *
335 * @hide
336 */
337 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
338 public static final String ACTION_PROVISION_MANAGED_SHAREABLE_DEVICE
339 = "android.app.action.PROVISION_MANAGED_SHAREABLE_DEVICE";
340
341 /**
Alan Treadwayafad8782016-01-19 15:15:08 +0000342 * Activity action: Finalizes management provisioning, should be used after user-setup
343 * has been completed and {@link #getUserProvisioningState()} returns one of:
344 * <ul>
345 * <li>{@link #STATE_USER_SETUP_INCOMPLETE}</li>
346 * <li>{@link #STATE_USER_SETUP_COMPLETE}</li>
347 * <li>{@link #STATE_USER_PROFILE_COMPLETE}</li>
348 * </ul>
349 *
350 * @hide
351 */
Benjamin Franzeed2a8e2016-02-19 14:19:05 +0000352 @SystemApi
Alan Treadwayafad8782016-01-19 15:15:08 +0000353 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
354 public static final String ACTION_PROVISION_FINALIZATION
355 = "android.app.action.PROVISION_FINALIZATION";
356
357 /**
Michal Karpinskiba244092016-02-25 17:28:24 +0000358 * Action: Bugreport sharing with device owner has been accepted by the user.
359 *
360 * @hide
361 */
362 public static final String ACTION_BUGREPORT_SHARING_ACCEPTED =
363 "com.android.server.action.BUGREPORT_SHARING_ACCEPTED";
364
365 /**
366 * Action: Bugreport sharing with device owner has been declined by the user.
367 *
368 * @hide
369 */
370 public static final String ACTION_BUGREPORT_SHARING_DECLINED =
371 "com.android.server.action.BUGREPORT_SHARING_DECLINED";
372
373 /**
374 * Action: Bugreport has been collected and is dispatched to {@link DevicePolicyManagerService}.
375 *
376 * @hide
377 */
378 public static final String ACTION_REMOTE_BUGREPORT_DISPATCH =
379 "android.intent.action.REMOTE_BUGREPORT_DISPATCH";
380
381 /**
382 * Extra for shared bugreport's SHA-256 hash.
383 *
384 * @hide
385 */
386 public static final String EXTRA_REMOTE_BUGREPORT_HASH =
387 "android.intent.extra.REMOTE_BUGREPORT_HASH";
388
389 /**
390 * Extra for remote bugreport notification shown type.
391 *
392 * @hide
393 */
394 public static final String EXTRA_BUGREPORT_NOTIFICATION_TYPE =
395 "android.app.extra.bugreport_notification_type";
396
397 /**
398 * Notification type for a started remote bugreport flow.
399 *
400 * @hide
401 */
402 public static final int NOTIFICATION_BUGREPORT_STARTED = 1;
403
404 /**
405 * Notification type for a bugreport that has already been accepted to be shared, but is still
406 * being taken.
407 *
408 * @hide
409 */
410 public static final int NOTIFICATION_BUGREPORT_ACCEPTED_NOT_FINISHED = 2;
411
412 /**
413 * Notification type for a bugreport that has been taken and can be shared or declined.
414 *
415 * @hide
416 */
417 public static final int NOTIFICATION_BUGREPORT_FINISHED_NOT_ACCEPTED = 3;
418
419 /**
Rubin Xua4f9dc12015-06-12 13:27:59 +0100420 * A {@link android.os.Parcelable} extra of type {@link android.os.PersistableBundle} that
Rubin Xu41f2ccb92015-08-05 16:29:13 +0100421 * allows a mobile device management application or NFC programmer application which starts
422 * managed provisioning to pass data to the management application instance after provisioning.
Rubin Xua4f9dc12015-06-12 13:27:59 +0100423 * <p>
424 * If used with {@link #ACTION_PROVISION_MANAGED_PROFILE} it can be used by the application that
425 * sends the intent to pass data to itself on the newly created profile.
426 * If used with {@link #ACTION_PROVISION_MANAGED_DEVICE} it allows passing data to the same
427 * instance of the app on the primary user.
Rubin Xu41f2ccb92015-08-05 16:29:13 +0100428 * Starting from {@link android.os.Build.VERSION_CODES#M}, if used with
429 * {@link #MIME_TYPE_PROVISIONING_NFC} as part of NFC managed device provisioning, the NFC
430 * message should contain a stringified {@link java.util.Properties} instance, whose string
431 * properties will be converted into a {@link android.os.PersistableBundle} and passed to the
432 * management application after provisioning.
433 *
Rubin Xua4f9dc12015-06-12 13:27:59 +0100434 * <p>
435 * In both cases the application receives the data in
Brian Carlstromf1fe51b2014-09-03 08:55:05 -0700436 * {@link DeviceAdminReceiver#onProfileProvisioningComplete} via an intent with the action
437 * {@link DeviceAdminReceiver#ACTION_PROFILE_PROVISIONING_COMPLETE}. The bundle is not changed
Rubin Xua4f9dc12015-06-12 13:27:59 +0100438 * during the managed provisioning.
Sander Alewijnse90f14bf2014-08-20 16:22:44 +0100439 */
440 public static final String EXTRA_PROVISIONING_ADMIN_EXTRAS_BUNDLE =
Esteban Talavera37f01842014-09-05 10:50:57 +0100441 "android.app.extra.PROVISIONING_ADMIN_EXTRAS_BUNDLE";
Sander Alewijnse90f14bf2014-08-20 16:22:44 +0100442
443 /**
Sander Alewijnse1cc4ecc2014-06-23 19:56:52 +0100444 * A String extra holding the package name of the mobile device management application that
445 * will be set as the profile owner or device owner.
446 *
447 * <p>If an application starts provisioning directly via an intent with action
448 * {@link #ACTION_PROVISION_MANAGED_PROFILE} this package has to match the package name of the
449 * application that started provisioning. The package will be set as profile owner in that case.
450 *
Sander Alewijnse8c411562014-11-12 18:03:11 +0000451 * <p>This package is set as device owner when device owner provisioning is started by an NFC
452 * message containing an NFC record with MIME type {@link #MIME_TYPE_PROVISIONING_NFC}.
Nicolas Prevot18440252015-03-09 14:07:17 +0000453 *
454 * <p> When this extra is set, the application must have exactly one device admin receiver.
Robin Lee25e26452015-06-02 09:56:29 -0700455 * This receiver will be set as the profile or device owner and active admin.
Benjamin Franzea956242016-03-21 15:45:56 +0000456 *
Nicolas Prevot18440252015-03-09 14:07:17 +0000457 * @see DeviceAdminReceiver
458 * @deprecated Use {@link #EXTRA_PROVISIONING_DEVICE_ADMIN_COMPONENT_NAME}. This extra is still
Nicolas Prevot8f78d6a2015-08-21 11:06:31 +0100459 * supported, but only if there is only one device admin receiver in the package that requires
460 * the permission {@link android.Manifest.permission#BIND_DEVICE_ADMIN}.
Jessica Hummelf72078b2014-03-06 16:13:12 +0000461 */
Nicolas Prevot18440252015-03-09 14:07:17 +0000462 @Deprecated
Jessica Hummelf72078b2014-03-06 16:13:12 +0000463 public static final String EXTRA_PROVISIONING_DEVICE_ADMIN_PACKAGE_NAME
Esteban Talaveraef9c5232014-09-08 13:51:18 +0100464 = "android.app.extra.PROVISIONING_DEVICE_ADMIN_PACKAGE_NAME";
Jessica Hummelf72078b2014-03-06 16:13:12 +0000465
466 /**
Nicolas Prevot18440252015-03-09 14:07:17 +0000467 * A ComponentName extra indicating the device admin receiver of the mobile device management
468 * application that will be set as the profile owner or device owner and active admin.
469 *
470 * <p>If an application starts provisioning directly via an intent with action
Nicolas Prevot64bf7b22015-04-29 14:43:49 +0100471 * {@link #ACTION_PROVISION_MANAGED_PROFILE} or
472 * {@link #ACTION_PROVISION_MANAGED_DEVICE} the package name of this
473 * component has to match the package name of the application that started provisioning.
Nicolas Prevot18440252015-03-09 14:07:17 +0000474 *
475 * <p>This component is set as device owner and active admin when device owner provisioning is
Nicolas Prevot64bf7b22015-04-29 14:43:49 +0100476 * started by an intent with action {@link #ACTION_PROVISION_MANAGED_DEVICE} or by an NFC
477 * message containing an NFC record with MIME type
Benjamin Franzea956242016-03-21 15:45:56 +0000478 * {@link #MIME_TYPE_PROVISIONING_NFC}. For the NFC record, the component name must be
Rubin Xu44ef750b2015-03-23 16:51:33 +0000479 * flattened to a string, via {@link ComponentName#flattenToShortString()}.
Nicolas Prevot18440252015-03-09 14:07:17 +0000480 *
481 * @see DeviceAdminReceiver
482 */
483 public static final String EXTRA_PROVISIONING_DEVICE_ADMIN_COMPONENT_NAME
484 = "android.app.extra.PROVISIONING_DEVICE_ADMIN_COMPONENT_NAME";
485
486 /**
Alexandra Gherghinaaaf2f3e2014-11-13 12:46:15 +0000487 * An {@link android.accounts.Account} extra holding the account to migrate during managed
488 * profile provisioning. If the account supplied is present in the primary user, it will be
489 * copied, along with its credentials to the managed profile and removed from the primary user.
490 *
491 * Use with {@link #ACTION_PROVISION_MANAGED_PROFILE}.
492 */
493
494 public static final String EXTRA_PROVISIONING_ACCOUNT_TO_MIGRATE
495 = "android.app.extra.PROVISIONING_ACCOUNT_TO_MIGRATE";
496
497 /**
Jessica Hummele3da7902014-08-20 15:20:11 +0100498 * A String extra that, holds the email address of the account which a managed profile is
499 * created for. Used with {@link #ACTION_PROVISION_MANAGED_PROFILE} and
500 * {@link DeviceAdminReceiver#ACTION_PROFILE_PROVISIONING_COMPLETE}.
Sander Alewijnse1cc4ecc2014-06-23 19:56:52 +0100501 *
Sander Alewijnse2b338a22014-09-12 12:28:40 +0100502 * <p> This extra is part of the {@link #EXTRA_PROVISIONING_ADMIN_EXTRAS_BUNDLE}.
503 *
Jessica Hummele3da7902014-08-20 15:20:11 +0100504 * <p> If the {@link #ACTION_PROVISION_MANAGED_PROFILE} intent that starts managed provisioning
505 * contains this extra, it is forwarded in the
506 * {@link DeviceAdminReceiver#ACTION_PROFILE_PROVISIONING_COMPLETE} intent to the mobile
507 * device management application that was set as the profile owner during provisioning.
508 * It is usually used to avoid that the user has to enter their email address twice.
Nicolas Prevot07ac20b2014-05-27 15:37:45 +0100509 */
Sander Alewijnse2b338a22014-09-12 12:28:40 +0100510 public static final String EXTRA_PROVISIONING_EMAIL_ADDRESS
511 = "android.app.extra.PROVISIONING_EMAIL_ADDRESS";
Nicolas Prevot07ac20b2014-05-27 15:37:45 +0100512
513 /**
Nicolas Prevotcd2d8592015-11-23 13:27:21 +0000514 * A integer extra indicating the predominant color to show during the provisioning.
515 * Refer to {@link android.graphics.Color} for how the color is represented.
Nicolas Prevotcaf11cd2015-11-19 10:58:35 +0000516 *
517 * <p>Use with {@link #ACTION_PROVISION_MANAGED_PROFILE} or
518 * {@link #ACTION_PROVISION_MANAGED_DEVICE}.
519 */
520 public static final String EXTRA_PROVISIONING_MAIN_COLOR =
521 "android.app.extra.PROVISIONING_MAIN_COLOR";
522
523 /**
Sander Alewijnse8c411562014-11-12 18:03:11 +0000524 * A Boolean extra that can be used by the mobile device management application to skip the
Robin Lee25e26452015-06-02 09:56:29 -0700525 * disabling of system apps during provisioning when set to {@code true}.
Sander Alewijnse8c411562014-11-12 18:03:11 +0000526 *
Nicolas Prevot64bf7b22015-04-29 14:43:49 +0100527 * <p>Use in an NFC record with {@link #MIME_TYPE_PROVISIONING_NFC} or an intent with action
528 * {@link #ACTION_PROVISION_MANAGED_DEVICE} that starts device owner provisioning.
Sander Alewijnse8c411562014-11-12 18:03:11 +0000529 */
Sander Alewijnse5a144252014-11-18 13:25:04 +0000530 public static final String EXTRA_PROVISIONING_LEAVE_ALL_SYSTEM_APPS_ENABLED =
531 "android.app.extra.PROVISIONING_LEAVE_ALL_SYSTEM_APPS_ENABLED";
Sander Alewijnse8c411562014-11-12 18:03:11 +0000532
533 /**
Sander Alewijnse1cc4ecc2014-06-23 19:56:52 +0100534 * A String extra holding the time zone {@link android.app.AlarmManager} that the device
535 * will be set to.
536 *
Sander Alewijnse8c411562014-11-12 18:03:11 +0000537 * <p>Use in an NFC record with {@link #MIME_TYPE_PROVISIONING_NFC} that starts device owner
538 * provisioning via an NFC bump.
Sander Alewijnse1cc4ecc2014-06-23 19:56:52 +0100539 */
540 public static final String EXTRA_PROVISIONING_TIME_ZONE
Esteban Talavera37f01842014-09-05 10:50:57 +0100541 = "android.app.extra.PROVISIONING_TIME_ZONE";
Sander Alewijnse1cc4ecc2014-06-23 19:56:52 +0100542
543 /**
Esteban Talaverad469a0b2014-08-20 13:54:25 +0100544 * A Long extra holding the wall clock time (in milliseconds) to be set on the device's
545 * {@link android.app.AlarmManager}.
Sander Alewijnse1cc4ecc2014-06-23 19:56:52 +0100546 *
Sander Alewijnse8c411562014-11-12 18:03:11 +0000547 * <p>Use in an NFC record with {@link #MIME_TYPE_PROVISIONING_NFC} that starts device owner
548 * provisioning via an NFC bump.
Sander Alewijnse1cc4ecc2014-06-23 19:56:52 +0100549 */
550 public static final String EXTRA_PROVISIONING_LOCAL_TIME
Esteban Talavera37f01842014-09-05 10:50:57 +0100551 = "android.app.extra.PROVISIONING_LOCAL_TIME";
Sander Alewijnse1cc4ecc2014-06-23 19:56:52 +0100552
553 /**
554 * A String extra holding the {@link java.util.Locale} that the device will be set to.
555 * Format: xx_yy, where xx is the language code, and yy the country code.
556 *
Sander Alewijnse8c411562014-11-12 18:03:11 +0000557 * <p>Use in an NFC record with {@link #MIME_TYPE_PROVISIONING_NFC} that starts device owner
558 * provisioning via an NFC bump.
Sander Alewijnse1cc4ecc2014-06-23 19:56:52 +0100559 */
560 public static final String EXTRA_PROVISIONING_LOCALE
Esteban Talavera37f01842014-09-05 10:50:57 +0100561 = "android.app.extra.PROVISIONING_LOCALE";
Sander Alewijnse1cc4ecc2014-06-23 19:56:52 +0100562
563 /**
564 * A String extra holding the ssid of the wifi network that should be used during nfc device
565 * owner provisioning for downloading the mobile device management application.
566 *
Sander Alewijnse8c411562014-11-12 18:03:11 +0000567 * <p>Use in an NFC record with {@link #MIME_TYPE_PROVISIONING_NFC} that starts device owner
568 * provisioning via an NFC bump.
Sander Alewijnse1cc4ecc2014-06-23 19:56:52 +0100569 */
570 public static final String EXTRA_PROVISIONING_WIFI_SSID
Esteban Talavera37f01842014-09-05 10:50:57 +0100571 = "android.app.extra.PROVISIONING_WIFI_SSID";
Sander Alewijnse1cc4ecc2014-06-23 19:56:52 +0100572
573 /**
574 * A boolean extra indicating whether the wifi network in {@link #EXTRA_PROVISIONING_WIFI_SSID}
575 * is hidden or not.
576 *
Sander Alewijnse8c411562014-11-12 18:03:11 +0000577 * <p>Use in an NFC record with {@link #MIME_TYPE_PROVISIONING_NFC} that starts device owner
578 * provisioning via an NFC bump.
Sander Alewijnse1cc4ecc2014-06-23 19:56:52 +0100579 */
580 public static final String EXTRA_PROVISIONING_WIFI_HIDDEN
Esteban Talavera37f01842014-09-05 10:50:57 +0100581 = "android.app.extra.PROVISIONING_WIFI_HIDDEN";
Sander Alewijnse1cc4ecc2014-06-23 19:56:52 +0100582
583 /**
584 * A String extra indicating the security type of the wifi network in
Mahaver Chopra76b08a92015-10-08 17:58:45 +0100585 * {@link #EXTRA_PROVISIONING_WIFI_SSID} and could be one of {@code NONE}, {@code WPA} or
586 * {@code WEP}.
Sander Alewijnse1cc4ecc2014-06-23 19:56:52 +0100587 *
Sander Alewijnse8c411562014-11-12 18:03:11 +0000588 * <p>Use in an NFC record with {@link #MIME_TYPE_PROVISIONING_NFC} that starts device owner
589 * provisioning via an NFC bump.
Sander Alewijnse1cc4ecc2014-06-23 19:56:52 +0100590 */
591 public static final String EXTRA_PROVISIONING_WIFI_SECURITY_TYPE
Esteban Talavera37f01842014-09-05 10:50:57 +0100592 = "android.app.extra.PROVISIONING_WIFI_SECURITY_TYPE";
Sander Alewijnse1cc4ecc2014-06-23 19:56:52 +0100593
594 /**
595 * A String extra holding the password of the wifi network in
596 * {@link #EXTRA_PROVISIONING_WIFI_SSID}.
597 *
Sander Alewijnse8c411562014-11-12 18:03:11 +0000598 * <p>Use in an NFC record with {@link #MIME_TYPE_PROVISIONING_NFC} that starts device owner
599 * provisioning via an NFC bump.
Sander Alewijnse1cc4ecc2014-06-23 19:56:52 +0100600 */
601 public static final String EXTRA_PROVISIONING_WIFI_PASSWORD
Esteban Talavera37f01842014-09-05 10:50:57 +0100602 = "android.app.extra.PROVISIONING_WIFI_PASSWORD";
Sander Alewijnse1cc4ecc2014-06-23 19:56:52 +0100603
604 /**
605 * A String extra holding the proxy host for the wifi network in
606 * {@link #EXTRA_PROVISIONING_WIFI_SSID}.
607 *
Sander Alewijnse8c411562014-11-12 18:03:11 +0000608 * <p>Use in an NFC record with {@link #MIME_TYPE_PROVISIONING_NFC} that starts device owner
609 * provisioning via an NFC bump.
Sander Alewijnse1cc4ecc2014-06-23 19:56:52 +0100610 */
611 public static final String EXTRA_PROVISIONING_WIFI_PROXY_HOST
Esteban Talavera37f01842014-09-05 10:50:57 +0100612 = "android.app.extra.PROVISIONING_WIFI_PROXY_HOST";
Sander Alewijnse1cc4ecc2014-06-23 19:56:52 +0100613
614 /**
615 * An int extra holding the proxy port for the wifi network in
616 * {@link #EXTRA_PROVISIONING_WIFI_SSID}.
617 *
Sander Alewijnse8c411562014-11-12 18:03:11 +0000618 * <p>Use in an NFC record with {@link #MIME_TYPE_PROVISIONING_NFC} that starts device owner
619 * provisioning via an NFC bump.
Sander Alewijnse1cc4ecc2014-06-23 19:56:52 +0100620 */
621 public static final String EXTRA_PROVISIONING_WIFI_PROXY_PORT
Esteban Talavera37f01842014-09-05 10:50:57 +0100622 = "android.app.extra.PROVISIONING_WIFI_PROXY_PORT";
Sander Alewijnse1cc4ecc2014-06-23 19:56:52 +0100623
624 /**
625 * A String extra holding the proxy bypass for the wifi network in
626 * {@link #EXTRA_PROVISIONING_WIFI_SSID}.
627 *
Sander Alewijnse8c411562014-11-12 18:03:11 +0000628 * <p>Use in an NFC record with {@link #MIME_TYPE_PROVISIONING_NFC} that starts device owner
629 * provisioning via an NFC bump.
Sander Alewijnse1cc4ecc2014-06-23 19:56:52 +0100630 */
631 public static final String EXTRA_PROVISIONING_WIFI_PROXY_BYPASS
Esteban Talavera37f01842014-09-05 10:50:57 +0100632 = "android.app.extra.PROVISIONING_WIFI_PROXY_BYPASS";
Sander Alewijnse1cc4ecc2014-06-23 19:56:52 +0100633
634 /**
635 * A String extra holding the proxy auto-config (PAC) URL for the wifi network in
636 * {@link #EXTRA_PROVISIONING_WIFI_SSID}.
637 *
Sander Alewijnse8c411562014-11-12 18:03:11 +0000638 * <p>Use in an NFC record with {@link #MIME_TYPE_PROVISIONING_NFC} that starts device owner
639 * provisioning via an NFC bump.
Sander Alewijnse1cc4ecc2014-06-23 19:56:52 +0100640 */
641 public static final String EXTRA_PROVISIONING_WIFI_PAC_URL
Esteban Talavera37f01842014-09-05 10:50:57 +0100642 = "android.app.extra.PROVISIONING_WIFI_PAC_URL";
Sander Alewijnse1cc4ecc2014-06-23 19:56:52 +0100643
644 /**
645 * A String extra holding a url that specifies the download location of the device admin
646 * package. When not provided it is assumed that the device admin package is already installed.
647 *
Sander Alewijnse8c411562014-11-12 18:03:11 +0000648 * <p>Use in an NFC record with {@link #MIME_TYPE_PROVISIONING_NFC} that starts device owner
649 * provisioning via an NFC bump.
Sander Alewijnse1cc4ecc2014-06-23 19:56:52 +0100650 */
651 public static final String EXTRA_PROVISIONING_DEVICE_ADMIN_PACKAGE_DOWNLOAD_LOCATION
Esteban Talavera37f01842014-09-05 10:50:57 +0100652 = "android.app.extra.PROVISIONING_DEVICE_ADMIN_PACKAGE_DOWNLOAD_LOCATION";
Sander Alewijnse1cc4ecc2014-06-23 19:56:52 +0100653
654 /**
Julia Reynoldsc1731742015-03-19 14:56:28 -0400655 * An int extra holding a minimum required version code for the device admin package. If the
656 * device admin is already installed on the device, it will only be re-downloaded from
657 * {@link #EXTRA_PROVISIONING_DEVICE_ADMIN_PACKAGE_DOWNLOAD_LOCATION} if the version of the
658 * installed package is less than this version code.
659 *
Craig Lafayette3cc72ba2015-06-26 11:51:04 -0400660 * <p>Use in an NFC record with {@link #MIME_TYPE_PROVISIONING_NFC} that starts device owner
Julia Reynoldsc1731742015-03-19 14:56:28 -0400661 * provisioning via an NFC bump.
662 */
663 public static final String EXTRA_PROVISIONING_DEVICE_ADMIN_MINIMUM_VERSION_CODE
664 = "android.app.extra.PROVISIONING_DEVICE_ADMIN_MINIMUM_VERSION_CODE";
665
666 /**
Sander Alewijnse681bce92014-07-24 16:46:26 +0100667 * A String extra holding a http cookie header which should be used in the http request to the
668 * url specified in {@link #EXTRA_PROVISIONING_DEVICE_ADMIN_PACKAGE_DOWNLOAD_LOCATION}.
669 *
Sander Alewijnse8c411562014-11-12 18:03:11 +0000670 * <p>Use in an NFC record with {@link #MIME_TYPE_PROVISIONING_NFC} that starts device owner
671 * provisioning via an NFC bump.
Sander Alewijnse681bce92014-07-24 16:46:26 +0100672 */
673 public static final String EXTRA_PROVISIONING_DEVICE_ADMIN_PACKAGE_DOWNLOAD_COOKIE_HEADER
Esteban Talavera37f01842014-09-05 10:50:57 +0100674 = "android.app.extra.PROVISIONING_DEVICE_ADMIN_PACKAGE_DOWNLOAD_COOKIE_HEADER";
Sander Alewijnse681bce92014-07-24 16:46:26 +0100675
676 /**
Rubin Xud92e7572015-05-18 17:01:13 +0100677 * A String extra holding the URL-safe base64 encoded SHA-256 or SHA-1 hash (see notes below) of
678 * the file at download location specified in
679 * {@link #EXTRA_PROVISIONING_DEVICE_ADMIN_PACKAGE_DOWNLOAD_LOCATION}.
Sander Alewijnsee4f878cb2015-04-14 10:49:17 +0100680 *
Benjamin Franzea956242016-03-21 15:45:56 +0000681 * <p>Either this extra or {@link #EXTRA_PROVISIONING_DEVICE_ADMIN_SIGNATURE_CHECKSUM} must be
682 * present. The provided checksum must match the checksum of the file at the download
Sander Alewijnsee4f878cb2015-04-14 10:49:17 +0100683 * location. If the checksum doesn't match an error will be shown to the user and the user will
684 * be asked to factory reset the device.
Sander Alewijnse1cc4ecc2014-06-23 19:56:52 +0100685 *
Sander Alewijnse8c411562014-11-12 18:03:11 +0000686 * <p>Use in an NFC record with {@link #MIME_TYPE_PROVISIONING_NFC} that starts device owner
687 * provisioning via an NFC bump.
Rubin Xud92e7572015-05-18 17:01:13 +0100688 *
689 * <p><strong>Note:</strong> for devices running {@link android.os.Build.VERSION_CODES#LOLLIPOP}
690 * and {@link android.os.Build.VERSION_CODES#LOLLIPOP_MR1} only SHA-1 hash is supported.
Dianne Hackborn0e3de6c2015-07-29 15:20:21 -0700691 * Starting from {@link android.os.Build.VERSION_CODES#M}, this parameter accepts SHA-256 in
Rubin Xud92e7572015-05-18 17:01:13 +0100692 * addition to SHA-1. Support for SHA-1 is likely to be removed in future OS releases.
Sander Alewijnse1cc4ecc2014-06-23 19:56:52 +0100693 */
694 public static final String EXTRA_PROVISIONING_DEVICE_ADMIN_PACKAGE_CHECKSUM
Esteban Talavera37f01842014-09-05 10:50:57 +0100695 = "android.app.extra.PROVISIONING_DEVICE_ADMIN_PACKAGE_CHECKSUM";
Sander Alewijnse1cc4ecc2014-06-23 19:56:52 +0100696
697 /**
Rubin Xud92e7572015-05-18 17:01:13 +0100698 * A String extra holding the URL-safe base64 encoded SHA-256 checksum of any signature of the
Sander Alewijnsee4f878cb2015-04-14 10:49:17 +0100699 * android package archive at the download location specified in {@link
700 * #EXTRA_PROVISIONING_DEVICE_ADMIN_PACKAGE_DOWNLOAD_LOCATION}.
701 *
Rubin Xu5c82d2c2015-06-02 09:29:46 +0100702 * <p>The signatures of an android package archive can be obtained using
Sander Alewijnsee4f878cb2015-04-14 10:49:17 +0100703 * {@link android.content.pm.PackageManager#getPackageArchiveInfo} with flag
704 * {@link android.content.pm.PackageManager#GET_SIGNATURES}.
705 *
Benjamin Franzea956242016-03-21 15:45:56 +0000706 * <p>Either this extra or {@link #EXTRA_PROVISIONING_DEVICE_ADMIN_PACKAGE_CHECKSUM} must be
707 * present. The provided checksum must match the checksum of any signature of the file at
Sander Alewijnsee4f878cb2015-04-14 10:49:17 +0100708 * the download location. If the checksum does not match an error will be shown to the user and
709 * the user will be asked to factory reset the device.
710 *
711 * <p>Use in an NFC record with {@link #MIME_TYPE_PROVISIONING_NFC} that starts device owner
712 * provisioning via an NFC bump.
713 */
Rubin Xu5c82d2c2015-06-02 09:29:46 +0100714 public static final String EXTRA_PROVISIONING_DEVICE_ADMIN_SIGNATURE_CHECKSUM
715 = "android.app.extra.PROVISIONING_DEVICE_ADMIN_SIGNATURE_CHECKSUM";
Sander Alewijnsee4f878cb2015-04-14 10:49:17 +0100716
717 /**
Alexandra Gherghinadb4bc572015-01-08 12:17:40 +0000718 * Broadcast Action: This broadcast is sent to indicate that provisioning of a managed profile
719 * has completed successfully.
720 *
721 * <p>The broadcast is limited to the primary profile, to the app specified in the provisioning
Nicolas Prevotebe2d992015-05-12 18:14:53 -0700722 * intent with action {@link #ACTION_PROVISION_MANAGED_PROFILE}.
Alexandra Gherghinadb4bc572015-01-08 12:17:40 +0000723 *
Ying Wang7f38aab2015-02-20 11:50:09 -0800724 * <p>This intent will contain the extra {@link #EXTRA_PROVISIONING_ACCOUNT_TO_MIGRATE} which
Alexandra Gherghinadb4bc572015-01-08 12:17:40 +0000725 * corresponds to the account requested to be migrated at provisioning time, if any.
726 */
727 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
728 public static final String ACTION_MANAGED_PROFILE_PROVISIONED
729 = "android.app.action.MANAGED_PROFILE_PROVISIONED";
730
731 /**
Benjamin Franzea956242016-03-21 15:45:56 +0000732 * A boolean extra indicating whether device encryption can be skipped as part of device owner
733 * or managed profile provisioning.
Julia Reynoldsa9ec70b2015-02-02 09:54:26 -0500734 *
Craig Lafayette3cc72ba2015-06-26 11:51:04 -0400735 * <p>Use in an NFC record with {@link #MIME_TYPE_PROVISIONING_NFC} or an intent with action
Nicolas Prevot64bf7b22015-04-29 14:43:49 +0100736 * {@link #ACTION_PROVISION_MANAGED_DEVICE} that starts device owner provisioning.
Benjamin Franzea956242016-03-21 15:45:56 +0000737 *
738 * <p>From {@link android.os.Build.VERSION_CODES#N} onwards, this is also supported for an
739 * intent with action {@link #ACTION_PROVISION_MANAGED_PROFILE}.
Julia Reynoldsa9ec70b2015-02-02 09:54:26 -0500740 */
741 public static final String EXTRA_PROVISIONING_SKIP_ENCRYPTION =
742 "android.app.extra.PROVISIONING_SKIP_ENCRYPTION";
743
744 /**
Nicolas Prevot8b7991c2015-11-12 17:40:12 +0000745 * A {@link Uri} extra pointing to a logo image. This image will be shown during the
746 * provisioning. If this extra is not passed, a default image will be shown.
747 * <h5>The following URI schemes are accepted:</h5>
748 * <ul>
749 * <li>content ({@link android.content.ContentResolver#SCHEME_CONTENT})</li>
750 * <li>android.resource ({@link android.content.ContentResolver#SCHEME_ANDROID_RESOURCE})</li>
751 * </ul>
752 *
753 * <p> It is the responsability of the caller to provide an image with a reasonable
754 * pixed density for the device.
755 *
756 * <p> If a content: URI is passed, the intent should have the flag
757 * {@link Intent#FLAG_GRANT_READ_URI_PERMISSION} and the uri should be added to the
758 * {@link android.content.ClipData} of the intent too.
759 *
760 * <p>Use in an intent with action {@link #ACTION_PROVISION_MANAGED_PROFILE} or
761 * {@link #ACTION_PROVISION_MANAGED_DEVICE}
762 */
763 public static final String EXTRA_PROVISIONING_LOGO_URI =
764 "android.app.extra.PROVISIONING_LOGO_URI";
765
766 /**
Alan Treadway94de8c82016-01-11 10:25:23 +0000767 * A boolean extra indicating if user setup should be skipped, for when provisioning is started
768 * during setup-wizard.
769 *
770 * <p>If unspecified, defaults to {@code true} to match the behavior in
771 * {@link android.os.Build.VERSION_CODES#M} and earlier.
772 *
Alan Treadway1a538d02016-01-18 16:42:30 +0000773 * <p>Use in an intent with action {@link #ACTION_PROVISION_MANAGED_DEVICE} or
774 * {@link #ACTION_PROVISION_MANAGED_USER}.
Alan Treadway94de8c82016-01-11 10:25:23 +0000775 *
776 * @hide
777 */
778 public static final String EXTRA_PROVISIONING_SKIP_USER_SETUP =
779 "android.app.extra.PROVISIONING_SKIP_USER_SETUP";
780
781 /**
Benjamin Franzea956242016-03-21 15:45:56 +0000782 * This MIME type is used for starting the device owner provisioning.
Sander Alewijnse1cc4ecc2014-06-23 19:56:52 +0100783 *
Craig Lafayette3cc72ba2015-06-26 11:51:04 -0400784 * <p>During device owner provisioning a device admin app is set as the owner of the device.
785 * A device owner has full control over the device. The device owner can not be modified by the
786 * user and the only way of resetting the device is if the device owner app calls a factory
787 * reset.
788 *
789 * <p> A typical use case would be a device that is owned by a company, but used by either an
790 * employee or client.
791 *
Benjamin Franzea956242016-03-21 15:45:56 +0000792 * <p> The NFC message must be sent to an unprovisioned device.
Sander Alewijnse1cc4ecc2014-06-23 19:56:52 +0100793 *
Sander Alewijnse8c411562014-11-12 18:03:11 +0000794 * <p>The NFC record must contain a serialized {@link java.util.Properties} object which
Sander Alewijnse1cc4ecc2014-06-23 19:56:52 +0100795 * contains the following properties:
796 * <ul>
Andrei Kapishnikov35e71f52015-03-16 17:24:04 -0400797 * <li>{@link #EXTRA_PROVISIONING_DEVICE_ADMIN_PACKAGE_NAME}</li>
798 * <li>{@link #EXTRA_PROVISIONING_DEVICE_ADMIN_PACKAGE_DOWNLOAD_LOCATION}, optional</li>
Sander Alewijnse681bce92014-07-24 16:46:26 +0100799 * <li>{@link #EXTRA_PROVISIONING_DEVICE_ADMIN_PACKAGE_DOWNLOAD_COOKIE_HEADER}, optional</li>
Andrei Kapishnikov35e71f52015-03-16 17:24:04 -0400800 * <li>{@link #EXTRA_PROVISIONING_DEVICE_ADMIN_PACKAGE_CHECKSUM}, optional</li>
Sander Alewijnse1cc4ecc2014-06-23 19:56:52 +0100801 * <li>{@link #EXTRA_PROVISIONING_LOCAL_TIME} (convert to String), optional</li>
802 * <li>{@link #EXTRA_PROVISIONING_TIME_ZONE}, optional</li>
803 * <li>{@link #EXTRA_PROVISIONING_LOCALE}, optional</li>
804 * <li>{@link #EXTRA_PROVISIONING_WIFI_SSID}, optional</li>
805 * <li>{@link #EXTRA_PROVISIONING_WIFI_HIDDEN} (convert to String), optional</li>
806 * <li>{@link #EXTRA_PROVISIONING_WIFI_SECURITY_TYPE}, optional</li>
807 * <li>{@link #EXTRA_PROVISIONING_WIFI_PASSWORD}, optional</li>
808 * <li>{@link #EXTRA_PROVISIONING_WIFI_PROXY_HOST}, optional</li>
809 * <li>{@link #EXTRA_PROVISIONING_WIFI_PROXY_PORT} (convert to String), optional</li>
810 * <li>{@link #EXTRA_PROVISIONING_WIFI_PROXY_BYPASS}, optional</li>
Rubin Xu41f2ccb92015-08-05 16:29:13 +0100811 * <li>{@link #EXTRA_PROVISIONING_WIFI_PAC_URL}, optional</li>
812 * <li>{@link #EXTRA_PROVISIONING_ADMIN_EXTRAS_BUNDLE}, optional, supported from
813 * {@link android.os.Build.VERSION_CODES#M} </li></ul>
Sander Alewijnse1cc4ecc2014-06-23 19:56:52 +0100814 *
Nicolas Prevot18440252015-03-09 14:07:17 +0000815 * <p>
Dianne Hackborn0e3de6c2015-07-29 15:20:21 -0700816 * As of {@link android.os.Build.VERSION_CODES#M}, the properties should contain
Andrei Kapishnikov35e71f52015-03-16 17:24:04 -0400817 * {@link #EXTRA_PROVISIONING_DEVICE_ADMIN_COMPONENT_NAME} instead of
818 * {@link #EXTRA_PROVISIONING_DEVICE_ADMIN_PACKAGE_NAME}, (although specifying only
819 * {@link #EXTRA_PROVISIONING_DEVICE_ADMIN_PACKAGE_NAME} is still supported).
Andrei Kapishnikov35e71f52015-03-16 17:24:04 -0400820 */
821 public static final String MIME_TYPE_PROVISIONING_NFC
822 = "application/com.android.managedprovisioning";
823
Sander Alewijnse1cc4ecc2014-06-23 19:56:52 +0100824 /**
Dianne Hackbornd6847842010-01-12 18:14:19 -0800825 * Activity action: ask the user to add a new device administrator to the system.
826 * The desired policy is the ComponentName of the policy in the
827 * {@link #EXTRA_DEVICE_ADMIN} extra field. This will invoke a UI to
828 * bring the user through adding the device administrator to the system (or
829 * allowing them to reject it).
Konstantin Lopyrev32558232010-05-20 16:18:05 -0700830 *
Dianne Hackborn8ea138c2010-01-26 18:01:04 -0800831 * <p>You can optionally include the {@link #EXTRA_ADD_EXPLANATION}
832 * field to provide the user with additional explanation (in addition
833 * to your component's description) about what is being added.
Andy Stadlerc25f70a2010-12-08 15:56:45 -0800834 *
835 * <p>If your administrator is already active, this will ordinarily return immediately (without
836 * user intervention). However, if your administrator has been updated and is requesting
837 * additional uses-policy flags, the user will be presented with the new list. New policies
838 * will not be available to the updated administrator until the user has accepted the new list.
Dianne Hackbornd6847842010-01-12 18:14:19 -0800839 */
840 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
841 public static final String ACTION_ADD_DEVICE_ADMIN
842 = "android.app.action.ADD_DEVICE_ADMIN";
Konstantin Lopyrev32558232010-05-20 16:18:05 -0700843
Dianne Hackbornd6847842010-01-12 18:14:19 -0800844 /**
Amith Yamasanibf3a9462014-07-28 14:26:42 -0700845 * @hide
846 * Activity action: ask the user to add a new device administrator as the profile owner
Amith Yamasani814e9872015-03-23 14:04:53 -0700847 * for this user. Only system apps can launch this intent.
Amith Yamasanibf3a9462014-07-28 14:26:42 -0700848 *
Amith Yamasani814e9872015-03-23 14:04:53 -0700849 * <p>The ComponentName of the profile owner admin is passed in the {@link #EXTRA_DEVICE_ADMIN}
850 * extra field. This will invoke a UI to bring the user through adding the profile owner admin
Amith Yamasanibf3a9462014-07-28 14:26:42 -0700851 * to remotely control restrictions on the user.
852 *
Makoto Onukic8a5a552015-11-19 14:29:12 -0800853 * <p>The intent must be invoked via {@link Activity#startActivityForResult} to receive the
Amith Yamasanibf3a9462014-07-28 14:26:42 -0700854 * result of whether or not the user approved the action. If approved, the result will
855 * be {@link Activity#RESULT_OK} and the component will be set as an active admin as well
856 * as a profile owner.
857 *
858 * <p>You can optionally include the {@link #EXTRA_ADD_EXPLANATION}
859 * field to provide the user with additional explanation (in addition
860 * to your component's description) about what is being added.
861 *
Amith Yamasani814e9872015-03-23 14:04:53 -0700862 * <p>If there is already a profile owner active or the caller is not a system app, the
863 * operation will return a failure result.
Amith Yamasanibf3a9462014-07-28 14:26:42 -0700864 */
865 @SystemApi
866 public static final String ACTION_SET_PROFILE_OWNER
867 = "android.app.action.SET_PROFILE_OWNER";
868
869 /**
870 * @hide
871 * Name of the profile owner admin that controls the user.
872 */
873 @SystemApi
874 public static final String EXTRA_PROFILE_OWNER_NAME
875 = "android.app.extra.PROFILE_OWNER_NAME";
876
877 /**
Nicolas Prevot00799002015-07-27 18:15:20 +0100878 * Broadcast action: send when any policy admin changes a policy.
Jim Miller284b62e2010-06-08 14:27:42 -0700879 * This is generally used to find out when a new policy is in effect.
Jim Miller3e5d3fd2011-09-02 17:30:35 -0700880 *
Jim Miller284b62e2010-06-08 14:27:42 -0700881 * @hide
882 */
883 public static final String ACTION_DEVICE_POLICY_MANAGER_STATE_CHANGED
884 = "android.app.action.DEVICE_POLICY_MANAGER_STATE_CHANGED";
885
886 /**
Nicolas Prevot00799002015-07-27 18:15:20 +0100887 * Broadcast action: sent when the device owner is set or changed.
888 *
889 * This broadcast is sent only to the primary user.
890 * @see #ACTION_PROVISION_MANAGED_DEVICE
891 */
892 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
893 public static final String ACTION_DEVICE_OWNER_CHANGED
894 = "android.app.action.DEVICE_OWNER_CHANGED";
895
896 /**
Dianne Hackbornd6847842010-01-12 18:14:19 -0800897 * The ComponentName of the administrator component.
898 *
899 * @see #ACTION_ADD_DEVICE_ADMIN
900 */
901 public static final String EXTRA_DEVICE_ADMIN = "android.app.extra.DEVICE_ADMIN";
Konstantin Lopyrev32558232010-05-20 16:18:05 -0700902
Dianne Hackbornd6847842010-01-12 18:14:19 -0800903 /**
Dianne Hackborn8ea138c2010-01-26 18:01:04 -0800904 * An optional CharSequence providing additional explanation for why the
905 * admin is being added.
906 *
907 * @see #ACTION_ADD_DEVICE_ADMIN
908 */
909 public static final String EXTRA_ADD_EXPLANATION = "android.app.extra.ADD_EXPLANATION";
Konstantin Lopyrev32558232010-05-20 16:18:05 -0700910
Dianne Hackborn8ea138c2010-01-26 18:01:04 -0800911 /**
Konstantin Lopyrev32558232010-05-20 16:18:05 -0700912 * Activity action: have the user enter a new password. This activity should
913 * be launched after using {@link #setPasswordQuality(ComponentName, int)},
914 * or {@link #setPasswordMinimumLength(ComponentName, int)} to have the user
915 * enter a new password that meets the current requirements. You can use
916 * {@link #isActivePasswordSufficient()} to determine whether you need to
917 * have the user select a new password in order to meet the current
918 * constraints. Upon being resumed from this activity, you can check the new
919 * password characteristics to see if they are sufficient.
Benjamin Franzc9921092016-01-08 17:17:44 +0000920 *
921 * If the intent is launched from within a managed profile with a profile
922 * owner built against {@link android.os.Build.VERSION_CODES#M} or before,
923 * this will trigger entering a new password for the parent of the profile.
924 * For all other cases it will trigger entering a new password for the user
925 * or profile it is launched from.
Esteban Talaverac1c83592016-02-17 17:56:15 +0000926 *
927 * @see #ACTION_SET_NEW_PARENT_PROFILE_PASSWORD
Dianne Hackbornd6847842010-01-12 18:14:19 -0800928 */
929 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
930 public static final String ACTION_SET_NEW_PASSWORD
931 = "android.app.action.SET_NEW_PASSWORD";
Amith Yamasanibf3a9462014-07-28 14:26:42 -0700932
Nicolas Prevot10fa67c2014-03-24 13:44:38 +0000933 /**
Benjamin Franzc9921092016-01-08 17:17:44 +0000934 * Activity action: have the user enter a new password for the parent profile.
935 * If the intent is launched from within a managed profile, this will trigger
936 * entering a new password for the parent of the profile. In all other cases
937 * the behaviour is identical to {@link #ACTION_SET_NEW_PASSWORD}.
938 */
939 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
940 public static final String ACTION_SET_NEW_PARENT_PROFILE_PASSWORD
941 = "android.app.action.SET_NEW_PARENT_PROFILE_PASSWORD";
942
943 /**
Nicolas Prevot2c1c5dd2015-01-12 12:32:56 +0000944 * Flag used by {@link #addCrossProfileIntentFilter} to allow activities in
945 * the parent profile to access intents sent from the managed profile.
946 * That is, when an app in the managed profile calls
947 * {@link Activity#startActivity(Intent)}, the intent can be resolved by a
948 * matching activity in the parent profile.
Nicolas Prevot10fa67c2014-03-24 13:44:38 +0000949 */
Nicolas Prevot86a96732014-09-08 12:13:05 +0100950 public static final int FLAG_PARENT_CAN_ACCESS_MANAGED = 0x0001;
Nicolas Prevot10fa67c2014-03-24 13:44:38 +0000951
952 /**
Nicolas Prevot2c1c5dd2015-01-12 12:32:56 +0000953 * Flag used by {@link #addCrossProfileIntentFilter} to allow activities in
954 * the managed profile to access intents sent from the parent profile.
955 * That is, when an app in the parent profile calls
956 * {@link Activity#startActivity(Intent)}, the intent can be resolved by a
957 * matching activity in the managed profile.
Nicolas Prevot10fa67c2014-03-24 13:44:38 +0000958 */
Nicolas Prevot86a96732014-09-08 12:13:05 +0100959 public static final int FLAG_MANAGED_CAN_ACCESS_PARENT = 0x0002;
Konstantin Lopyrev32558232010-05-20 16:18:05 -0700960
Dianne Hackbornd6847842010-01-12 18:14:19 -0800961 /**
Rubin Xu5faad8e2015-04-20 17:43:48 +0100962 * Broadcast action: notify that a new local system update policy has been set by the device
963 * owner. The new policy can be retrieved by {@link #getSystemUpdatePolicy()}.
Rubin Xu8027a4f2015-03-10 17:52:37 +0000964 */
965 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Rubin Xu5faad8e2015-04-20 17:43:48 +0100966 public static final String ACTION_SYSTEM_UPDATE_POLICY_CHANGED
967 = "android.app.action.SYSTEM_UPDATE_POLICY_CHANGED";
Rubin Xu8027a4f2015-03-10 17:52:37 +0000968
Amith Yamasanid49489b2015-04-28 14:00:26 -0700969 /**
970 * Permission policy to prompt user for new permission requests for runtime permissions.
971 * Already granted or denied permissions are not affected by this.
972 */
973 public static final int PERMISSION_POLICY_PROMPT = 0;
974
975 /**
976 * Permission policy to always grant new permission requests for runtime permissions.
977 * Already granted or denied permissions are not affected by this.
978 */
979 public static final int PERMISSION_POLICY_AUTO_GRANT = 1;
980
981 /**
982 * Permission policy to always deny new permission requests for runtime permissions.
983 * Already granted or denied permissions are not affected by this.
984 */
985 public static final int PERMISSION_POLICY_AUTO_DENY = 2;
986
Svet Ganovd8ecc5a2015-05-20 10:45:43 -0700987 /**
988 * Runtime permission state: The user can manage the permission
989 * through the UI.
990 */
991 public static final int PERMISSION_GRANT_STATE_DEFAULT = 0;
992
993 /**
994 * Runtime permission state: The permission is granted to the app
995 * and the user cannot manage the permission through the UI.
996 */
997 public static final int PERMISSION_GRANT_STATE_GRANTED = 1;
998
999 /**
1000 * Runtime permission state: The permission is denied to the app
1001 * and the user cannot manage the permission through the UI.
1002 */
1003 public static final int PERMISSION_GRANT_STATE_DENIED = 2;
Rubin Xu8027a4f2015-03-10 17:52:37 +00001004
1005 /**
Alan Treadwayafad8782016-01-19 15:15:08 +00001006 * No management for current user in-effect. This is the default.
1007 * @hide
1008 */
Benjamin Franzeed2a8e2016-02-19 14:19:05 +00001009 @SystemApi
Alan Treadwayafad8782016-01-19 15:15:08 +00001010 public static final int STATE_USER_UNMANAGED = 0;
1011
1012 /**
1013 * Management partially setup, user setup needs to be completed.
1014 * @hide
1015 */
Benjamin Franzeed2a8e2016-02-19 14:19:05 +00001016 @SystemApi
Alan Treadwayafad8782016-01-19 15:15:08 +00001017 public static final int STATE_USER_SETUP_INCOMPLETE = 1;
1018
1019 /**
1020 * Management partially setup, user setup completed.
1021 * @hide
1022 */
Benjamin Franzeed2a8e2016-02-19 14:19:05 +00001023 @SystemApi
Alan Treadwayafad8782016-01-19 15:15:08 +00001024 public static final int STATE_USER_SETUP_COMPLETE = 2;
1025
1026 /**
1027 * Management setup and active on current user.
1028 * @hide
1029 */
Benjamin Franzeed2a8e2016-02-19 14:19:05 +00001030 @SystemApi
Alan Treadwayafad8782016-01-19 15:15:08 +00001031 public static final int STATE_USER_SETUP_FINALIZED = 3;
1032
1033 /**
1034 * Management partially setup on a managed profile.
1035 * @hide
1036 */
Benjamin Franzeed2a8e2016-02-19 14:19:05 +00001037 @SystemApi
Alan Treadwayafad8782016-01-19 15:15:08 +00001038 public static final int STATE_USER_PROFILE_COMPLETE = 4;
1039
1040 /**
1041 * @hide
1042 */
1043 @IntDef({STATE_USER_UNMANAGED, STATE_USER_SETUP_INCOMPLETE, STATE_USER_SETUP_COMPLETE,
1044 STATE_USER_SETUP_FINALIZED, STATE_USER_PROFILE_COMPLETE})
1045 @Retention(RetentionPolicy.SOURCE)
1046 public @interface UserProvisioningState {}
1047
1048 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07001049 * Return true if the given administrator component is currently active (enabled) in the system.
1050 *
1051 * @param admin The administrator component to check for.
1052 * @return {@code true} if {@code admin} is currently enabled in the system, {@code false}
1053 * otherwise
Dianne Hackbornd6847842010-01-12 18:14:19 -08001054 */
Robin Lee25e26452015-06-02 09:56:29 -07001055 public boolean isAdminActive(@NonNull ComponentName admin) {
Makoto Onukicc4bbeb2015-09-17 10:28:24 -07001056 return isAdminActiveAsUser(admin, myUserId());
Zoltan Szatmary-Ban3f1ddf82014-07-02 16:42:05 +01001057 }
1058
1059 /**
1060 * @see #isAdminActive(ComponentName)
1061 * @hide
1062 */
Robin Lee25e26452015-06-02 09:56:29 -07001063 public boolean isAdminActiveAsUser(@NonNull ComponentName admin, int userId) {
Dianne Hackbornd6847842010-01-12 18:14:19 -08001064 if (mService != null) {
1065 try {
Robin Lee25e26452015-06-02 09:56:29 -07001066 return mService.isAdminActive(admin, userId);
Dianne Hackbornd6847842010-01-12 18:14:19 -08001067 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07001068 throw e.rethrowFromSystemServer();
Dianne Hackbornd6847842010-01-12 18:14:19 -08001069 }
1070 }
1071 return false;
1072 }
Fyodor Kupolov96fb9322014-12-01 15:08:09 -08001073 /**
1074 * Return true if the given administrator component is currently being removed
1075 * for the user.
1076 * @hide
1077 */
Robin Lee25e26452015-06-02 09:56:29 -07001078 public boolean isRemovingAdmin(@NonNull ComponentName admin, int userId) {
Fyodor Kupolov96fb9322014-12-01 15:08:09 -08001079 if (mService != null) {
1080 try {
Robin Lee25e26452015-06-02 09:56:29 -07001081 return mService.isRemovingAdmin(admin, userId);
Fyodor Kupolov96fb9322014-12-01 15:08:09 -08001082 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07001083 throw e.rethrowFromSystemServer();
Fyodor Kupolov96fb9322014-12-01 15:08:09 -08001084 }
1085 }
1086 return false;
1087 }
1088
Konstantin Lopyrev32558232010-05-20 16:18:05 -07001089
Dianne Hackbornd6847842010-01-12 18:14:19 -08001090 /**
Robin Lee25e26452015-06-02 09:56:29 -07001091 * Return a list of all currently active device administrators' component
1092 * names. If there are no administrators {@code null} may be
Dianne Hackbornd47c6ed2010-01-27 16:21:20 -08001093 * returned.
1094 */
1095 public List<ComponentName> getActiveAdmins() {
Benjamin Franzbc33c822016-04-15 08:57:52 +01001096 throwIfParentInstance("getActiveAdmins");
Makoto Onukicc4bbeb2015-09-17 10:28:24 -07001097 return getActiveAdminsAsUser(myUserId());
Zoltan Szatmary-Ban3f1ddf82014-07-02 16:42:05 +01001098 }
1099
1100 /**
1101 * @see #getActiveAdmins()
1102 * @hide
1103 */
1104 public List<ComponentName> getActiveAdminsAsUser(int userId) {
Dianne Hackbornd47c6ed2010-01-27 16:21:20 -08001105 if (mService != null) {
1106 try {
Zoltan Szatmary-Ban3f1ddf82014-07-02 16:42:05 +01001107 return mService.getActiveAdmins(userId);
Dianne Hackbornd47c6ed2010-01-27 16:21:20 -08001108 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07001109 throw e.rethrowFromSystemServer();
Dianne Hackbornd47c6ed2010-01-27 16:21:20 -08001110 }
1111 }
1112 return null;
1113 }
Konstantin Lopyrev32558232010-05-20 16:18:05 -07001114
Dianne Hackbornd47c6ed2010-01-27 16:21:20 -08001115 /**
Amith Yamasani599dd7c2012-09-14 23:20:08 -07001116 * Used by package administration code to determine if a package can be stopped
1117 * or uninstalled.
Dianne Hackborn21f1bd12010-02-19 17:02:21 -08001118 * @hide
1119 */
1120 public boolean packageHasActiveAdmins(String packageName) {
Amith Yamasanica5d6d22016-02-16 13:58:46 -08001121 return packageHasActiveAdmins(packageName, myUserId());
1122 }
1123
1124 /**
1125 * Used by package administration code to determine if a package can be stopped
1126 * or uninstalled.
1127 * @hide
1128 */
1129 public boolean packageHasActiveAdmins(String packageName, int userId) {
Dianne Hackborn21f1bd12010-02-19 17:02:21 -08001130 if (mService != null) {
1131 try {
Amith Yamasanica5d6d22016-02-16 13:58:46 -08001132 return mService.packageHasActiveAdmins(packageName, userId);
Dianne Hackborn21f1bd12010-02-19 17:02:21 -08001133 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07001134 throw e.rethrowFromSystemServer();
Dianne Hackborn21f1bd12010-02-19 17:02:21 -08001135 }
1136 }
1137 return false;
1138 }
Konstantin Lopyrev32558232010-05-20 16:18:05 -07001139
Dianne Hackborn21f1bd12010-02-19 17:02:21 -08001140 /**
Dianne Hackbornd6847842010-01-12 18:14:19 -08001141 * Remove a current administration component. This can only be called
1142 * by the application that owns the administration component; if you
1143 * try to remove someone else's component, a security exception will be
1144 * thrown.
Esteban Talavera552a5612016-02-19 17:02:24 +00001145 *
1146 * <p>Note that the operation is not synchronous and the admin might still be active (as
1147 * indicated by {@link #getActiveAdmins()}) by the time this method returns.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07001148 *
1149 * @param admin The administration compononent to remove.
1150 * @throws SecurityException if the caller is not in the owner application of {@code admin}.
Dianne Hackbornd6847842010-01-12 18:14:19 -08001151 */
Robin Lee25e26452015-06-02 09:56:29 -07001152 public void removeActiveAdmin(@NonNull ComponentName admin) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01001153 throwIfParentInstance("removeActiveAdmin");
Dianne Hackbornd6847842010-01-12 18:14:19 -08001154 if (mService != null) {
1155 try {
Makoto Onukicc4bbeb2015-09-17 10:28:24 -07001156 mService.removeActiveAdmin(admin, myUserId());
Dianne Hackbornd6847842010-01-12 18:14:19 -08001157 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07001158 throw e.rethrowFromSystemServer();
Dianne Hackbornd6847842010-01-12 18:14:19 -08001159 }
1160 }
1161 }
Konstantin Lopyrev32558232010-05-20 16:18:05 -07001162
Dianne Hackbornd6847842010-01-12 18:14:19 -08001163 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07001164 * Returns true if an administrator has been granted a particular device policy. This can be
1165 * used to check whether the administrator was activated under an earlier set of policies, but
1166 * requires additional policies after an upgrade.
Andy Stadlerc25f70a2010-12-08 15:56:45 -08001167 *
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07001168 * @param admin Which {@link DeviceAdminReceiver} this request is associated with. Must be an
1169 * active administrator, or an exception will be thrown.
Andy Stadlerc25f70a2010-12-08 15:56:45 -08001170 * @param usesPolicy Which uses-policy to check, as defined in {@link DeviceAdminInfo}.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07001171 * @throws SecurityException if {@code admin} is not an active administrator.
Andy Stadlerc25f70a2010-12-08 15:56:45 -08001172 */
Robin Lee25e26452015-06-02 09:56:29 -07001173 public boolean hasGrantedPolicy(@NonNull ComponentName admin, int usesPolicy) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01001174 throwIfParentInstance("hasGrantedPolicy");
Andy Stadlerc25f70a2010-12-08 15:56:45 -08001175 if (mService != null) {
1176 try {
Makoto Onukicc4bbeb2015-09-17 10:28:24 -07001177 return mService.hasGrantedPolicy(admin, usesPolicy, myUserId());
Andy Stadlerc25f70a2010-12-08 15:56:45 -08001178 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07001179 throw e.rethrowFromSystemServer();
Andy Stadlerc25f70a2010-12-08 15:56:45 -08001180 }
1181 }
1182 return false;
1183 }
1184
1185 /**
Clara Bayarria1771112015-12-18 16:29:18 +00001186 * Returns true if the Profile Challenge is available to use for the given profile user.
1187 *
1188 * @hide
1189 */
1190 public boolean isSeparateProfileChallengeAllowed(int userHandle) {
1191 if (mService != null) {
1192 try {
1193 return mService.isSeparateProfileChallengeAllowed(userHandle);
1194 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07001195 throw e.rethrowFromSystemServer();
Clara Bayarria1771112015-12-18 16:29:18 +00001196 }
1197 }
1198 return false;
1199 }
1200
1201 /**
Dianne Hackborn9327f4f2010-01-29 10:38:29 -08001202 * Constant for {@link #setPasswordQuality}: the policy has no requirements
1203 * for the password. Note that quality constants are ordered so that higher
Dianne Hackborndf83afa2010-01-20 13:37:26 -08001204 * values are more restrictive.
Dianne Hackbornd6847842010-01-12 18:14:19 -08001205 */
Dianne Hackborn9327f4f2010-01-29 10:38:29 -08001206 public static final int PASSWORD_QUALITY_UNSPECIFIED = 0;
Konstantin Lopyrev32558232010-05-20 16:18:05 -07001207
Dianne Hackbornd6847842010-01-12 18:14:19 -08001208 /**
Jim Miller3e5d3fd2011-09-02 17:30:35 -07001209 * Constant for {@link #setPasswordQuality}: the policy allows for low-security biometric
1210 * recognition technology. This implies technologies that can recognize the identity of
1211 * an individual to about a 3 digit PIN (false detection is less than 1 in 1,000).
1212 * Note that quality constants are ordered so that higher values are more restrictive.
1213 */
1214 public static final int PASSWORD_QUALITY_BIOMETRIC_WEAK = 0x8000;
1215
1216 /**
Dianne Hackborn9327f4f2010-01-29 10:38:29 -08001217 * Constant for {@link #setPasswordQuality}: the policy requires some kind
Benjamin Franzc6a96532015-06-16 11:23:38 +01001218 * of password or pattern, but doesn't care what it is. Note that quality constants
Dianne Hackborndf83afa2010-01-20 13:37:26 -08001219 * are ordered so that higher values are more restrictive.
Dianne Hackbornd6847842010-01-12 18:14:19 -08001220 */
Dianne Hackborn9327f4f2010-01-29 10:38:29 -08001221 public static final int PASSWORD_QUALITY_SOMETHING = 0x10000;
Konstantin Lopyrev32558232010-05-20 16:18:05 -07001222
Dianne Hackborndf83afa2010-01-20 13:37:26 -08001223 /**
Dianne Hackborn9327f4f2010-01-29 10:38:29 -08001224 * Constant for {@link #setPasswordQuality}: the user must have entered a
1225 * password containing at least numeric characters. Note that quality
1226 * constants are ordered so that higher values are more restrictive.
Dianne Hackborndf83afa2010-01-20 13:37:26 -08001227 */
Dianne Hackborn9327f4f2010-01-29 10:38:29 -08001228 public static final int PASSWORD_QUALITY_NUMERIC = 0x20000;
Konstantin Lopyrev32558232010-05-20 16:18:05 -07001229
Dianne Hackbornd6847842010-01-12 18:14:19 -08001230 /**
Dianne Hackborn9327f4f2010-01-29 10:38:29 -08001231 * Constant for {@link #setPasswordQuality}: the user must have entered a
Jim Miller85516d02014-01-31 17:08:37 -08001232 * password containing at least numeric characters with no repeating (4444)
1233 * or ordered (1234, 4321, 2468) sequences. Note that quality
1234 * constants are ordered so that higher values are more restrictive.
1235 */
1236 public static final int PASSWORD_QUALITY_NUMERIC_COMPLEX = 0x30000;
1237
1238 /**
1239 * Constant for {@link #setPasswordQuality}: the user must have entered a
Dianne Hackborn85f2c9c2010-03-22 11:12:48 -07001240 * password containing at least alphabetic (or other symbol) characters.
1241 * Note that quality constants are ordered so that higher values are more
1242 * restrictive.
1243 */
1244 public static final int PASSWORD_QUALITY_ALPHABETIC = 0x40000;
Konstantin Lopyrev32558232010-05-20 16:18:05 -07001245
Dianne Hackborn85f2c9c2010-03-22 11:12:48 -07001246 /**
1247 * Constant for {@link #setPasswordQuality}: the user must have entered a
Dianne Hackborn9327f4f2010-01-29 10:38:29 -08001248 * password containing at least <em>both></em> numeric <em>and</em>
Dianne Hackborn85f2c9c2010-03-22 11:12:48 -07001249 * alphabetic (or other symbol) characters. Note that quality constants are
Dianne Hackborn9327f4f2010-01-29 10:38:29 -08001250 * ordered so that higher values are more restrictive.
Dianne Hackbornd6847842010-01-12 18:14:19 -08001251 */
Dianne Hackborn85f2c9c2010-03-22 11:12:48 -07001252 public static final int PASSWORD_QUALITY_ALPHANUMERIC = 0x50000;
Konstantin Lopyrev32558232010-05-20 16:18:05 -07001253
Dianne Hackbornd6847842010-01-12 18:14:19 -08001254 /**
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001255 * Constant for {@link #setPasswordQuality}: the user must have entered a
Konstantin Lopyrevc8577402010-06-04 17:15:02 -07001256 * password containing at least a letter, a numerical digit and a special
1257 * symbol, by default. With this password quality, passwords can be
1258 * restricted to contain various sets of characters, like at least an
1259 * uppercase letter, etc. These are specified using various methods,
1260 * like {@link #setPasswordMinimumLowerCase(ComponentName, int)}. Note
1261 * that quality constants are ordered so that higher values are more
1262 * restrictive.
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001263 */
1264 public static final int PASSWORD_QUALITY_COMPLEX = 0x60000;
1265
1266 /**
Oleksandr Peletskyi0fdcd3d2016-01-13 16:49:56 +01001267 * Constant for {@link #setPasswordQuality}: the user is not allowed to
1268 * modify password. In case this password quality is set, the password is
1269 * managed by a profile owner. The profile owner can set any password,
1270 * as if {@link #PASSWORD_QUALITY_UNSPECIFIED} is used. Note
1271 * that quality constants are ordered so that higher values are more
1272 * restrictive. The value of {@link #PASSWORD_QUALITY_MANAGED} is
1273 * the highest.
1274 * @hide
1275 */
1276 public static final int PASSWORD_QUALITY_MANAGED = 0x80000;
1277
1278 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07001279 * Called by an application that is administering the device to set the password restrictions it
1280 * is imposing. After setting this, the user will not be able to enter a new password that is
1281 * not at least as restrictive as what has been set. Note that the current password will remain
1282 * until the user has set a new one, so the change does not take place immediately. To prompt
1283 * the user for a new password, use {@link #ACTION_SET_NEW_PASSWORD} or
Esteban Talaverac1c83592016-02-17 17:56:15 +00001284 * {@link #ACTION_SET_NEW_PARENT_PROFILE_PASSWORD} after calling this method.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07001285 * <p>
1286 * Quality constants are ordered so that higher values are more restrictive; thus the highest
1287 * requested quality constant (between the policy set here, the user's preference, and any other
1288 * considerations) is the one that is in effect.
1289 * <p>
1290 * The calling device admin must have requested
1291 * {@link DeviceAdminInfo#USES_POLICY_LIMIT_PASSWORD} to be able to call this method; if it has
1292 * not, a security exception will be thrown.
1293 * <p>
1294 * This method can be called on the {@link DevicePolicyManager} instance returned by
1295 * {@link #getParentProfileInstance(ComponentName)} in order to set restrictions on the parent
1296 * profile.
Esteban Talaverac1c83592016-02-17 17:56:15 +00001297 *
Dianne Hackbornef6b22f2010-02-16 20:38:49 -08001298 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07001299 * @param quality The new desired quality. One of {@link #PASSWORD_QUALITY_UNSPECIFIED},
1300 * {@link #PASSWORD_QUALITY_SOMETHING}, {@link #PASSWORD_QUALITY_NUMERIC},
1301 * {@link #PASSWORD_QUALITY_NUMERIC_COMPLEX}, {@link #PASSWORD_QUALITY_ALPHABETIC},
1302 * {@link #PASSWORD_QUALITY_ALPHANUMERIC} or {@link #PASSWORD_QUALITY_COMPLEX}.
1303 * @throws SecurityException if {@code admin} is not an active administrator or if {@code admin}
1304 * does not use {@link DeviceAdminInfo#USES_POLICY_LIMIT_PASSWORD}
Dianne Hackbornd6847842010-01-12 18:14:19 -08001305 */
Robin Lee25e26452015-06-02 09:56:29 -07001306 public void setPasswordQuality(@NonNull ComponentName admin, int quality) {
Dianne Hackbornd6847842010-01-12 18:14:19 -08001307 if (mService != null) {
1308 try {
Clara Bayarri3e826ef2015-12-14 17:51:22 +00001309 mService.setPasswordQuality(admin, quality, mParentInstance);
Dianne Hackbornd6847842010-01-12 18:14:19 -08001310 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07001311 throw e.rethrowFromSystemServer();
Dianne Hackbornd6847842010-01-12 18:14:19 -08001312 }
1313 }
1314 }
Konstantin Lopyrev32558232010-05-20 16:18:05 -07001315
Dianne Hackbornd6847842010-01-12 18:14:19 -08001316 /**
Esteban Talaverac1c83592016-02-17 17:56:15 +00001317 * Retrieve the current minimum password quality for a particular admin or all admins that set
Rubin Xud3609d42016-07-13 18:32:57 +01001318 * restrictions on this user and its participating profiles. Restrictions on profiles that have
Esteban Talaverac1c83592016-02-17 17:56:15 +00001319 * a separate challenge are not taken into account.
1320 *
1321 * <p>This method can be called on the {@link DevicePolicyManager} instance
1322 * returned by {@link #getParentProfileInstance(ComponentName)} in order to retrieve
1323 * restrictions on the parent profile.
1324 *
Robin Lee25e26452015-06-02 09:56:29 -07001325 * @param admin The name of the admin component to check, or {@code null} to aggregate
Dianne Hackborn254cb442010-01-27 19:23:59 -08001326 * all admins.
Dianne Hackbornd6847842010-01-12 18:14:19 -08001327 */
Robin Lee25e26452015-06-02 09:56:29 -07001328 public int getPasswordQuality(@Nullable ComponentName admin) {
Makoto Onukicc4bbeb2015-09-17 10:28:24 -07001329 return getPasswordQuality(admin, myUserId());
Amith Yamasani599dd7c2012-09-14 23:20:08 -07001330 }
1331
1332 /** @hide per-user version */
Robin Lee25e26452015-06-02 09:56:29 -07001333 public int getPasswordQuality(@Nullable ComponentName admin, int userHandle) {
Dianne Hackbornd6847842010-01-12 18:14:19 -08001334 if (mService != null) {
1335 try {
Clara Bayarri3e826ef2015-12-14 17:51:22 +00001336 return mService.getPasswordQuality(admin, userHandle, mParentInstance);
Dianne Hackbornd6847842010-01-12 18:14:19 -08001337 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07001338 throw e.rethrowFromSystemServer();
Dianne Hackbornd6847842010-01-12 18:14:19 -08001339 }
1340 }
Dianne Hackborn9327f4f2010-01-29 10:38:29 -08001341 return PASSWORD_QUALITY_UNSPECIFIED;
Dianne Hackbornd6847842010-01-12 18:14:19 -08001342 }
Konstantin Lopyrev32558232010-05-20 16:18:05 -07001343
Dianne Hackbornd6847842010-01-12 18:14:19 -08001344 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07001345 * Called by an application that is administering the device to set the minimum allowed password
1346 * length. After setting this, the user will not be able to enter a new password that is not at
1347 * least as restrictive as what has been set. Note that the current password will remain until
1348 * the user has set a new one, so the change does not take place immediately. To prompt the user
1349 * for a new password, use {@link #ACTION_SET_NEW_PASSWORD} or
1350 * {@link #ACTION_SET_NEW_PARENT_PROFILE_PASSWORD} after setting this value. This constraint is
1351 * only imposed if the administrator has also requested either {@link #PASSWORD_QUALITY_NUMERIC}
1352 * , {@link #PASSWORD_QUALITY_NUMERIC_COMPLEX}, {@link #PASSWORD_QUALITY_ALPHABETIC},
1353 * {@link #PASSWORD_QUALITY_ALPHANUMERIC}, or {@link #PASSWORD_QUALITY_COMPLEX} with
1354 * {@link #setPasswordQuality}.
1355 * <p>
1356 * The calling device admin must have requested
1357 * {@link DeviceAdminInfo#USES_POLICY_LIMIT_PASSWORD} to be able to call this method; if it has
1358 * not, a security exception will be thrown.
1359 * <p>
1360 * This method can be called on the {@link DevicePolicyManager} instance returned by
1361 * {@link #getParentProfileInstance(ComponentName)} in order to set restrictions on the parent
1362 * profile.
Esteban Talaverac1c83592016-02-17 17:56:15 +00001363 *
Dianne Hackbornef6b22f2010-02-16 20:38:49 -08001364 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07001365 * @param length The new desired minimum password length. A value of 0 means there is no
1366 * restriction.
1367 * @throws SecurityException if {@code admin} is not an active administrator or {@code admin}
1368 * does not use {@link DeviceAdminInfo#USES_POLICY_LIMIT_PASSWORD}
Dianne Hackbornd6847842010-01-12 18:14:19 -08001369 */
Robin Lee25e26452015-06-02 09:56:29 -07001370 public void setPasswordMinimumLength(@NonNull ComponentName admin, int length) {
Dianne Hackbornd6847842010-01-12 18:14:19 -08001371 if (mService != null) {
1372 try {
Esteban Talavera62399912016-01-11 15:37:55 +00001373 mService.setPasswordMinimumLength(admin, length, mParentInstance);
Dianne Hackbornd6847842010-01-12 18:14:19 -08001374 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07001375 throw e.rethrowFromSystemServer();
Dianne Hackbornd6847842010-01-12 18:14:19 -08001376 }
1377 }
1378 }
Konstantin Lopyrev32558232010-05-20 16:18:05 -07001379
Dianne Hackbornd6847842010-01-12 18:14:19 -08001380 /**
Esteban Talaverac1c83592016-02-17 17:56:15 +00001381 * Retrieve the current minimum password length for a particular admin or all admins that set
Rubin Xud3609d42016-07-13 18:32:57 +01001382 * restrictions on this user and its participating profiles. Restrictions on profiles that have
Esteban Talaverac1c83592016-02-17 17:56:15 +00001383 * a separate challenge are not taken into account.
1384 *
1385 * <p>This method can be called on the {@link DevicePolicyManager} instance
1386 * returned by {@link #getParentProfileInstance(ComponentName)} in order to retrieve
1387 * restrictions on the parent profile.
1388 *
Jessica Hummel91da58d2014-04-10 17:39:43 +01001389 * user and its profiles or a particular one.
Robin Lee25e26452015-06-02 09:56:29 -07001390 * @param admin The name of the admin component to check, or {@code null} to aggregate
Dianne Hackborn254cb442010-01-27 19:23:59 -08001391 * all admins.
Dianne Hackbornd6847842010-01-12 18:14:19 -08001392 */
Robin Lee25e26452015-06-02 09:56:29 -07001393 public int getPasswordMinimumLength(@Nullable ComponentName admin) {
Makoto Onukicc4bbeb2015-09-17 10:28:24 -07001394 return getPasswordMinimumLength(admin, myUserId());
Amith Yamasani599dd7c2012-09-14 23:20:08 -07001395 }
1396
1397 /** @hide per-user version */
Robin Lee25e26452015-06-02 09:56:29 -07001398 public int getPasswordMinimumLength(@Nullable ComponentName admin, int userHandle) {
Dianne Hackbornd6847842010-01-12 18:14:19 -08001399 if (mService != null) {
1400 try {
Esteban Talavera62399912016-01-11 15:37:55 +00001401 return mService.getPasswordMinimumLength(admin, userHandle, mParentInstance);
Dianne Hackbornd6847842010-01-12 18:14:19 -08001402 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07001403 throw e.rethrowFromSystemServer();
Dianne Hackbornd6847842010-01-12 18:14:19 -08001404 }
1405 }
1406 return 0;
1407 }
Konstantin Lopyrev32558232010-05-20 16:18:05 -07001408
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001409 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07001410 * Called by an application that is administering the device to set the minimum number of upper
1411 * case letters required in the password. After setting this, the user will not be able to enter
1412 * a new password that is not at least as restrictive as what has been set. Note that the
1413 * current password will remain until the user has set a new one, so the change does not take
1414 * place immediately. To prompt the user for a new password, use
1415 * {@link #ACTION_SET_NEW_PASSWORD} or {@link #ACTION_SET_NEW_PARENT_PROFILE_PASSWORD} after
1416 * setting this value. This constraint is only imposed if the administrator has also requested
1417 * {@link #PASSWORD_QUALITY_COMPLEX} with {@link #setPasswordQuality}. The default value is 0.
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001418 * <p>
1419 * The calling device admin must have requested
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07001420 * {@link DeviceAdminInfo#USES_POLICY_LIMIT_PASSWORD} to be able to call this method; if it has
1421 * not, a security exception will be thrown.
1422 * <p>
1423 * This method can be called on the {@link DevicePolicyManager} instance returned by
1424 * {@link #getParentProfileInstance(ComponentName)} in order to set restrictions on the parent
1425 * profile.
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001426 *
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07001427 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
1428 * @param length The new desired minimum number of upper case letters required in the password.
1429 * A value of 0 means there is no restriction.
1430 * @throws SecurityException if {@code admin} is not an active administrator or {@code admin}
1431 * does not use {@link DeviceAdminInfo#USES_POLICY_LIMIT_PASSWORD}
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001432 */
Robin Lee25e26452015-06-02 09:56:29 -07001433 public void setPasswordMinimumUpperCase(@NonNull ComponentName admin, int length) {
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001434 if (mService != null) {
1435 try {
Esteban Talavera62399912016-01-11 15:37:55 +00001436 mService.setPasswordMinimumUpperCase(admin, length, mParentInstance);
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001437 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07001438 throw e.rethrowFromSystemServer();
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001439 }
1440 }
1441 }
1442
1443 /**
Esteban Talaverac1c83592016-02-17 17:56:15 +00001444 * Retrieve the current number of upper case letters required in the password
Rubin Xud3609d42016-07-13 18:32:57 +01001445 * for a particular admin or all admins that set restrictions on this user and
Esteban Talaverac1c83592016-02-17 17:56:15 +00001446 * its participating profiles. Restrictions on profiles that have a separate challenge
1447 * are not taken into account.
Jessica Hummel91da58d2014-04-10 17:39:43 +01001448 * This is the same value as set by
Esteban Talaverac1c83592016-02-17 17:56:15 +00001449 * {@link #setPasswordMinimumUpperCase(ComponentName, int)}
Konstantin Lopyrevc8577402010-06-04 17:15:02 -07001450 * and only applies when the password quality is
1451 * {@link #PASSWORD_QUALITY_COMPLEX}.
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001452 *
Esteban Talaverac1c83592016-02-17 17:56:15 +00001453 * <p>This method can be called on the {@link DevicePolicyManager} instance
1454 * returned by {@link #getParentProfileInstance(ComponentName)} in order to retrieve
1455 * restrictions on the parent profile.
1456 *
Robin Lee25e26452015-06-02 09:56:29 -07001457 * @param admin The name of the admin component to check, or {@code null} to
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001458 * aggregate all admins.
1459 * @return The minimum number of upper case letters required in the
1460 * password.
1461 */
Robin Lee25e26452015-06-02 09:56:29 -07001462 public int getPasswordMinimumUpperCase(@Nullable ComponentName admin) {
Makoto Onukicc4bbeb2015-09-17 10:28:24 -07001463 return getPasswordMinimumUpperCase(admin, myUserId());
Amith Yamasani599dd7c2012-09-14 23:20:08 -07001464 }
1465
1466 /** @hide per-user version */
Robin Lee25e26452015-06-02 09:56:29 -07001467 public int getPasswordMinimumUpperCase(@Nullable ComponentName admin, int userHandle) {
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001468 if (mService != null) {
1469 try {
Esteban Talavera62399912016-01-11 15:37:55 +00001470 return mService.getPasswordMinimumUpperCase(admin, userHandle, mParentInstance);
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001471 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07001472 throw e.rethrowFromSystemServer();
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001473 }
1474 }
1475 return 0;
1476 }
1477
1478 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07001479 * Called by an application that is administering the device to set the minimum number of lower
1480 * case letters required in the password. After setting this, the user will not be able to enter
1481 * a new password that is not at least as restrictive as what has been set. Note that the
1482 * current password will remain until the user has set a new one, so the change does not take
1483 * place immediately. To prompt the user for a new password, use
1484 * {@link #ACTION_SET_NEW_PASSWORD} or {@link #ACTION_SET_NEW_PARENT_PROFILE_PASSWORD} after
1485 * setting this value. This constraint is only imposed if the administrator has also requested
1486 * {@link #PASSWORD_QUALITY_COMPLEX} with {@link #setPasswordQuality}. The default value is 0.
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001487 * <p>
1488 * The calling device admin must have requested
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07001489 * {@link DeviceAdminInfo#USES_POLICY_LIMIT_PASSWORD} to be able to call this method; if it has
1490 * not, a security exception will be thrown.
1491 * <p>
1492 * This method can be called on the {@link DevicePolicyManager} instance returned by
1493 * {@link #getParentProfileInstance(ComponentName)} in order to set restrictions on the parent
1494 * profile.
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001495 *
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07001496 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
1497 * @param length The new desired minimum number of lower case letters required in the password.
1498 * A value of 0 means there is no restriction.
1499 * @throws SecurityException if {@code admin} is not an active administrator or {@code admin}
1500 * does not use {@link DeviceAdminInfo#USES_POLICY_LIMIT_PASSWORD}
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001501 */
Robin Lee25e26452015-06-02 09:56:29 -07001502 public void setPasswordMinimumLowerCase(@NonNull ComponentName admin, int length) {
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001503 if (mService != null) {
1504 try {
Esteban Talavera62399912016-01-11 15:37:55 +00001505 mService.setPasswordMinimumLowerCase(admin, length, mParentInstance);
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001506 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07001507 throw e.rethrowFromSystemServer();
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001508 }
1509 }
1510 }
1511
1512 /**
Esteban Talaverac1c83592016-02-17 17:56:15 +00001513 * Retrieve the current number of lower case letters required in the password
Rubin Xud3609d42016-07-13 18:32:57 +01001514 * for a particular admin or all admins that set restrictions on this user
Esteban Talaverac1c83592016-02-17 17:56:15 +00001515 * and its participating profiles. Restrictions on profiles that have
1516 * a separate challenge are not taken into account.
Jessica Hummel91da58d2014-04-10 17:39:43 +01001517 * This is the same value as set by
Esteban Talaverac1c83592016-02-17 17:56:15 +00001518 * {@link #setPasswordMinimumLowerCase(ComponentName, int)}
Konstantin Lopyrevc8577402010-06-04 17:15:02 -07001519 * and only applies when the password quality is
1520 * {@link #PASSWORD_QUALITY_COMPLEX}.
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001521 *
Esteban Talaverac1c83592016-02-17 17:56:15 +00001522 * <p>This method can be called on the {@link DevicePolicyManager} instance
1523 * returned by {@link #getParentProfileInstance(ComponentName)} in order to retrieve
1524 * restrictions on the parent profile.
1525 *
Robin Lee25e26452015-06-02 09:56:29 -07001526 * @param admin The name of the admin component to check, or {@code null} to
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001527 * aggregate all admins.
1528 * @return The minimum number of lower case letters required in the
1529 * password.
1530 */
Robin Lee25e26452015-06-02 09:56:29 -07001531 public int getPasswordMinimumLowerCase(@Nullable ComponentName admin) {
Makoto Onukicc4bbeb2015-09-17 10:28:24 -07001532 return getPasswordMinimumLowerCase(admin, myUserId());
Amith Yamasani599dd7c2012-09-14 23:20:08 -07001533 }
1534
1535 /** @hide per-user version */
Robin Lee25e26452015-06-02 09:56:29 -07001536 public int getPasswordMinimumLowerCase(@Nullable ComponentName admin, int userHandle) {
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001537 if (mService != null) {
1538 try {
Esteban Talavera62399912016-01-11 15:37:55 +00001539 return mService.getPasswordMinimumLowerCase(admin, userHandle, mParentInstance);
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001540 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07001541 throw e.rethrowFromSystemServer();
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001542 }
1543 }
1544 return 0;
1545 }
1546
1547 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07001548 * Called by an application that is administering the device to set the minimum number of
1549 * letters required in the password. After setting this, the user will not be able to enter a
1550 * new password that is not at least as restrictive as what has been set. Note that the current
1551 * password will remain until the user has set a new one, so the change does not take place
1552 * immediately. To prompt the user for a new password, use {@link #ACTION_SET_NEW_PASSWORD} or
1553 * {@link #ACTION_SET_NEW_PARENT_PROFILE_PASSWORD} after setting this value. This constraint is
1554 * only imposed if the administrator has also requested {@link #PASSWORD_QUALITY_COMPLEX} with
1555 * {@link #setPasswordQuality}. The default value is 1.
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001556 * <p>
1557 * The calling device admin must have requested
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07001558 * {@link DeviceAdminInfo#USES_POLICY_LIMIT_PASSWORD} to be able to call this method; if it has
1559 * not, a security exception will be thrown.
1560 * <p>
1561 * This method can be called on the {@link DevicePolicyManager} instance returned by
1562 * {@link #getParentProfileInstance(ComponentName)} in order to set restrictions on the parent
1563 * profile.
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001564 *
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07001565 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
1566 * @param length The new desired minimum number of letters required in the password. A value of
1567 * 0 means there is no restriction.
1568 * @throws SecurityException if {@code admin} is not an active administrator or {@code admin}
1569 * does not use {@link DeviceAdminInfo#USES_POLICY_LIMIT_PASSWORD}
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001570 */
Robin Lee25e26452015-06-02 09:56:29 -07001571 public void setPasswordMinimumLetters(@NonNull ComponentName admin, int length) {
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001572 if (mService != null) {
1573 try {
Esteban Talavera62399912016-01-11 15:37:55 +00001574 mService.setPasswordMinimumLetters(admin, length, mParentInstance);
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001575 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07001576 throw e.rethrowFromSystemServer();
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001577 }
1578 }
1579 }
1580
1581 /**
Esteban Talaverac1c83592016-02-17 17:56:15 +00001582 * Retrieve the current number of letters required in the password
Rubin Xud3609d42016-07-13 18:32:57 +01001583 * for a particular admin or all admins that set restrictions on this user
Esteban Talaverac1c83592016-02-17 17:56:15 +00001584 * and its participating profiles. Restrictions on profiles that have
1585 * a separate challenge are not taken into account.
1586 * This is the same value as set by
1587 * {@link #setPasswordMinimumLetters(ComponentName, int)}
Konstantin Lopyrevc8577402010-06-04 17:15:02 -07001588 * and only applies when the password quality is
1589 * {@link #PASSWORD_QUALITY_COMPLEX}.
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001590 *
Esteban Talaverac1c83592016-02-17 17:56:15 +00001591 * <p>This method can be called on the {@link DevicePolicyManager} instance
1592 * returned by {@link #getParentProfileInstance(ComponentName)} in order to retrieve
1593 * restrictions on the parent profile.
1594 *
Robin Lee25e26452015-06-02 09:56:29 -07001595 * @param admin The name of the admin component to check, or {@code null} to
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001596 * aggregate all admins.
1597 * @return The minimum number of letters required in the password.
1598 */
Robin Lee25e26452015-06-02 09:56:29 -07001599 public int getPasswordMinimumLetters(@Nullable ComponentName admin) {
Makoto Onukicc4bbeb2015-09-17 10:28:24 -07001600 return getPasswordMinimumLetters(admin, myUserId());
Amith Yamasani599dd7c2012-09-14 23:20:08 -07001601 }
1602
1603 /** @hide per-user version */
Robin Lee25e26452015-06-02 09:56:29 -07001604 public int getPasswordMinimumLetters(@Nullable ComponentName admin, int userHandle) {
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001605 if (mService != null) {
1606 try {
Esteban Talavera62399912016-01-11 15:37:55 +00001607 return mService.getPasswordMinimumLetters(admin, userHandle, mParentInstance);
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001608 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07001609 throw e.rethrowFromSystemServer();
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001610 }
1611 }
1612 return 0;
1613 }
1614
1615 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07001616 * Called by an application that is administering the device to set the minimum number of
1617 * numerical digits required in the password. After setting this, the user will not be able to
1618 * enter a new password that is not at least as restrictive as what has been set. Note that the
1619 * current password will remain until the user has set a new one, so the change does not take
1620 * place immediately. To prompt the user for a new password, use
1621 * {@link #ACTION_SET_NEW_PASSWORD} or {@link #ACTION_SET_NEW_PARENT_PROFILE_PASSWORD} after
1622 * setting this value. This constraint is only imposed if the administrator has also requested
1623 * {@link #PASSWORD_QUALITY_COMPLEX} with {@link #setPasswordQuality}. The default value is 1.
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001624 * <p>
1625 * The calling device admin must have requested
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07001626 * {@link DeviceAdminInfo#USES_POLICY_LIMIT_PASSWORD} to be able to call this method; if it has
1627 * not, a security exception will be thrown.
1628 * <p>
1629 * This method can be called on the {@link DevicePolicyManager} instance returned by
1630 * {@link #getParentProfileInstance(ComponentName)} in order to set restrictions on the parent
1631 * profile.
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001632 *
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07001633 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
1634 * @param length The new desired minimum number of numerical digits required in the password. A
1635 * value of 0 means there is no restriction.
1636 * @throws SecurityException if {@code admin} is not an active administrator or {@code admin}
1637 * does not use {@link DeviceAdminInfo#USES_POLICY_LIMIT_PASSWORD}
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001638 */
Robin Lee25e26452015-06-02 09:56:29 -07001639 public void setPasswordMinimumNumeric(@NonNull ComponentName admin, int length) {
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001640 if (mService != null) {
1641 try {
Esteban Talavera62399912016-01-11 15:37:55 +00001642 mService.setPasswordMinimumNumeric(admin, length, mParentInstance);
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001643 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07001644 throw e.rethrowFromSystemServer();
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001645 }
1646 }
1647 }
1648
1649 /**
1650 * Retrieve the current number of numerical digits required in the password
Rubin Xud3609d42016-07-13 18:32:57 +01001651 * for a particular admin or all admins that set restrictions on this user
Esteban Talaverac1c83592016-02-17 17:56:15 +00001652 * and its participating profiles. Restrictions on profiles that have
1653 * a separate challenge are not taken into account.
Jessica Hummel91da58d2014-04-10 17:39:43 +01001654 * This is the same value as set by
Esteban Talaverac1c83592016-02-17 17:56:15 +00001655 * {@link #setPasswordMinimumNumeric(ComponentName, int)}
Konstantin Lopyrevc8577402010-06-04 17:15:02 -07001656 * and only applies when the password quality is
1657 * {@link #PASSWORD_QUALITY_COMPLEX}.
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001658 *
Esteban Talaverac1c83592016-02-17 17:56:15 +00001659 * <p>This method can be called on the {@link DevicePolicyManager} instance
1660 * returned by {@link #getParentProfileInstance(ComponentName)} in order to retrieve
1661 * restrictions on the parent profile.
1662 *
Robin Lee25e26452015-06-02 09:56:29 -07001663 * @param admin The name of the admin component to check, or {@code null} to
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001664 * aggregate all admins.
1665 * @return The minimum number of numerical digits required in the password.
1666 */
Robin Lee25e26452015-06-02 09:56:29 -07001667 public int getPasswordMinimumNumeric(@Nullable ComponentName admin) {
Makoto Onukicc4bbeb2015-09-17 10:28:24 -07001668 return getPasswordMinimumNumeric(admin, myUserId());
Amith Yamasani599dd7c2012-09-14 23:20:08 -07001669 }
1670
1671 /** @hide per-user version */
Robin Lee25e26452015-06-02 09:56:29 -07001672 public int getPasswordMinimumNumeric(@Nullable ComponentName admin, int userHandle) {
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001673 if (mService != null) {
1674 try {
Esteban Talavera62399912016-01-11 15:37:55 +00001675 return mService.getPasswordMinimumNumeric(admin, userHandle, mParentInstance);
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001676 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07001677 throw e.rethrowFromSystemServer();
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001678 }
1679 }
1680 return 0;
1681 }
1682
1683 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07001684 * Called by an application that is administering the device to set the minimum number of
1685 * symbols required in the password. After setting this, the user will not be able to enter a
1686 * new password that is not at least as restrictive as what has been set. Note that the current
1687 * password will remain until the user has set a new one, so the change does not take place
1688 * immediately. To prompt the user for a new password, use {@link #ACTION_SET_NEW_PASSWORD} or
1689 * {@link #ACTION_SET_NEW_PARENT_PROFILE_PASSWORD} after setting this value. This constraint is
1690 * only imposed if the administrator has also requested {@link #PASSWORD_QUALITY_COMPLEX} with
1691 * {@link #setPasswordQuality}. The default value is 1.
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001692 * <p>
1693 * The calling device admin must have requested
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07001694 * {@link DeviceAdminInfo#USES_POLICY_LIMIT_PASSWORD} to be able to call this method; if it has
1695 * not, a security exception will be thrown.
1696 * <p>
1697 * This method can be called on the {@link DevicePolicyManager} instance returned by
1698 * {@link #getParentProfileInstance(ComponentName)} in order to set restrictions on the parent
1699 * profile.
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001700 *
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07001701 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
1702 * @param length The new desired minimum number of symbols required in the password. A value of
1703 * 0 means there is no restriction.
1704 * @throws SecurityException if {@code admin} is not an active administrator or {@code admin}
1705 * does not use {@link DeviceAdminInfo#USES_POLICY_LIMIT_PASSWORD}
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001706 */
Robin Lee25e26452015-06-02 09:56:29 -07001707 public void setPasswordMinimumSymbols(@NonNull ComponentName admin, int length) {
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001708 if (mService != null) {
1709 try {
Esteban Talavera62399912016-01-11 15:37:55 +00001710 mService.setPasswordMinimumSymbols(admin, length, mParentInstance);
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001711 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07001712 throw e.rethrowFromSystemServer();
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001713 }
1714 }
1715 }
1716
1717 /**
Esteban Talaverac1c83592016-02-17 17:56:15 +00001718 * Retrieve the current number of symbols required in the password
Rubin Xud3609d42016-07-13 18:32:57 +01001719 * for a particular admin or all admins that set restrictions on this user
Esteban Talaverac1c83592016-02-17 17:56:15 +00001720 * and its participating profiles. Restrictions on profiles that have
1721 * a separate challenge are not taken into account. This is the same value as
1722 * set by {@link #setPasswordMinimumSymbols(ComponentName, int)}
Konstantin Lopyrevc8577402010-06-04 17:15:02 -07001723 * and only applies when the password quality is
1724 * {@link #PASSWORD_QUALITY_COMPLEX}.
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001725 *
Esteban Talaverac1c83592016-02-17 17:56:15 +00001726 * <p>This method can be called on the {@link DevicePolicyManager} instance
1727 * returned by {@link #getParentProfileInstance(ComponentName)} in order to retrieve
1728 * restrictions on the parent profile.
1729 *
Robin Lee25e26452015-06-02 09:56:29 -07001730 * @param admin The name of the admin component to check, or {@code null} to
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001731 * aggregate all admins.
1732 * @return The minimum number of symbols required in the password.
1733 */
Robin Lee25e26452015-06-02 09:56:29 -07001734 public int getPasswordMinimumSymbols(@Nullable ComponentName admin) {
Makoto Onukicc4bbeb2015-09-17 10:28:24 -07001735 return getPasswordMinimumSymbols(admin, myUserId());
Amith Yamasani599dd7c2012-09-14 23:20:08 -07001736 }
1737
1738 /** @hide per-user version */
Robin Lee25e26452015-06-02 09:56:29 -07001739 public int getPasswordMinimumSymbols(@Nullable ComponentName admin, int userHandle) {
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001740 if (mService != null) {
1741 try {
Esteban Talavera62399912016-01-11 15:37:55 +00001742 return mService.getPasswordMinimumSymbols(admin, userHandle, mParentInstance);
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001743 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07001744 throw e.rethrowFromSystemServer();
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001745 }
1746 }
1747 return 0;
1748 }
1749
Konstantin Lopyrevc8577402010-06-04 17:15:02 -07001750 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07001751 * Called by an application that is administering the device to set the minimum number of
1752 * non-letter characters (numerical digits or symbols) required in the password. After setting
1753 * this, the user will not be able to enter a new password that is not at least as restrictive
1754 * as what has been set. Note that the current password will remain until the user has set a new
1755 * one, so the change does not take place immediately. To prompt the user for a new password,
1756 * use {@link #ACTION_SET_NEW_PASSWORD} or {@link #ACTION_SET_NEW_PARENT_PROFILE_PASSWORD} after
1757 * setting this value. This constraint is only imposed if the administrator has also requested
1758 * {@link #PASSWORD_QUALITY_COMPLEX} with {@link #setPasswordQuality}. The default value is 0.
Konstantin Lopyrevc8577402010-06-04 17:15:02 -07001759 * <p>
1760 * The calling device admin must have requested
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07001761 * {@link DeviceAdminInfo#USES_POLICY_LIMIT_PASSWORD} to be able to call this method; if it has
1762 * not, a security exception will be thrown.
1763 * <p>
1764 * This method can be called on the {@link DevicePolicyManager} instance returned by
1765 * {@link #getParentProfileInstance(ComponentName)} in order to set restrictions on the parent
1766 * profile.
Konstantin Lopyrevc8577402010-06-04 17:15:02 -07001767 *
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07001768 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
1769 * @param length The new desired minimum number of letters required in the password. A value of
1770 * 0 means there is no restriction.
1771 * @throws SecurityException if {@code admin} is not an active administrator or {@code admin}
1772 * does not use {@link DeviceAdminInfo#USES_POLICY_LIMIT_PASSWORD}
Konstantin Lopyrevc8577402010-06-04 17:15:02 -07001773 */
Robin Lee25e26452015-06-02 09:56:29 -07001774 public void setPasswordMinimumNonLetter(@NonNull ComponentName admin, int length) {
Konstantin Lopyrevc8577402010-06-04 17:15:02 -07001775 if (mService != null) {
1776 try {
Esteban Talavera62399912016-01-11 15:37:55 +00001777 mService.setPasswordMinimumNonLetter(admin, length, mParentInstance);
Konstantin Lopyrevc8577402010-06-04 17:15:02 -07001778 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07001779 throw e.rethrowFromSystemServer();
Konstantin Lopyrevc8577402010-06-04 17:15:02 -07001780 }
1781 }
1782 }
1783
1784 /**
Esteban Talaverac1c83592016-02-17 17:56:15 +00001785 * Retrieve the current number of non-letter characters required in the password
Rubin Xud3609d42016-07-13 18:32:57 +01001786 * for a particular admin or all admins that set restrictions on this user
Esteban Talaverac1c83592016-02-17 17:56:15 +00001787 * and its participating profiles. Restrictions on profiles that have
1788 * a separate challenge are not taken into account.
Jessica Hummel91da58d2014-04-10 17:39:43 +01001789 * This is the same value as set by
Esteban Talaverac1c83592016-02-17 17:56:15 +00001790 * {@link #setPasswordMinimumNonLetter(ComponentName, int)}
Konstantin Lopyrevc8577402010-06-04 17:15:02 -07001791 * and only applies when the password quality is
1792 * {@link #PASSWORD_QUALITY_COMPLEX}.
1793 *
Esteban Talaverac1c83592016-02-17 17:56:15 +00001794 * <p>This method can be called on the {@link DevicePolicyManager} instance
1795 * returned by {@link #getParentProfileInstance(ComponentName)} in order to retrieve
1796 * restrictions on the parent profile.
1797 *
Robin Lee25e26452015-06-02 09:56:29 -07001798 * @param admin The name of the admin component to check, or {@code null} to
Konstantin Lopyrevc8577402010-06-04 17:15:02 -07001799 * aggregate all admins.
1800 * @return The minimum number of letters required in the password.
1801 */
Robin Lee25e26452015-06-02 09:56:29 -07001802 public int getPasswordMinimumNonLetter(@Nullable ComponentName admin) {
Makoto Onukicc4bbeb2015-09-17 10:28:24 -07001803 return getPasswordMinimumNonLetter(admin, myUserId());
Amith Yamasani599dd7c2012-09-14 23:20:08 -07001804 }
1805
1806 /** @hide per-user version */
Robin Lee25e26452015-06-02 09:56:29 -07001807 public int getPasswordMinimumNonLetter(@Nullable ComponentName admin, int userHandle) {
Konstantin Lopyrevc8577402010-06-04 17:15:02 -07001808 if (mService != null) {
1809 try {
Esteban Talavera62399912016-01-11 15:37:55 +00001810 return mService.getPasswordMinimumNonLetter(admin, userHandle, mParentInstance);
Konstantin Lopyrevc8577402010-06-04 17:15:02 -07001811 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07001812 throw e.rethrowFromSystemServer();
Konstantin Lopyrevc8577402010-06-04 17:15:02 -07001813 }
1814 }
1815 return 0;
1816 }
1817
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07001818 /**
1819 * Called by an application that is administering the device to set the length of the password
1820 * history. After setting this, the user will not be able to enter a new password that is the
1821 * same as any password in the history. Note that the current password will remain until the
1822 * user has set a new one, so the change does not take place immediately. To prompt the user for
1823 * a new password, use {@link #ACTION_SET_NEW_PASSWORD} or
1824 * {@link #ACTION_SET_NEW_PARENT_PROFILE_PASSWORD} after setting this value. This constraint is
1825 * only imposed if the administrator has also requested either {@link #PASSWORD_QUALITY_NUMERIC}
1826 * , {@link #PASSWORD_QUALITY_NUMERIC_COMPLEX} {@link #PASSWORD_QUALITY_ALPHABETIC}, or
1827 * {@link #PASSWORD_QUALITY_ALPHANUMERIC} with {@link #setPasswordQuality}.
1828 * <p>
1829 * The calling device admin must have requested
1830 * {@link DeviceAdminInfo#USES_POLICY_LIMIT_PASSWORD} to be able to call this method; if it has
1831 * not, a security exception will be thrown.
1832 * <p>
1833 * This method can be called on the {@link DevicePolicyManager} instance returned by
1834 * {@link #getParentProfileInstance(ComponentName)} in order to set restrictions on the parent
1835 * profile.
1836 *
1837 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
1838 * @param length The new desired length of password history. A value of 0 means there is no
1839 * restriction.
1840 * @throws SecurityException if {@code admin} is not an active administrator or {@code admin}
1841 * does not use {@link DeviceAdminInfo#USES_POLICY_LIMIT_PASSWORD}
1842 */
Robin Lee25e26452015-06-02 09:56:29 -07001843 public void setPasswordHistoryLength(@NonNull ComponentName admin, int length) {
Konstantin Lopyrev32558232010-05-20 16:18:05 -07001844 if (mService != null) {
1845 try {
Esteban Talavera62399912016-01-11 15:37:55 +00001846 mService.setPasswordHistoryLength(admin, length, mParentInstance);
Konstantin Lopyrev32558232010-05-20 16:18:05 -07001847 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07001848 throw e.rethrowFromSystemServer();
Konstantin Lopyrev32558232010-05-20 16:18:05 -07001849 }
1850 }
1851 }
1852
1853 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07001854 * Called by a device admin to set the password expiration timeout. Calling this method will
1855 * restart the countdown for password expiration for the given admin, as will changing the
1856 * device password (for all admins).
1857 * <p>
1858 * The provided timeout is the time delta in ms and will be added to the current time. For
1859 * example, to have the password expire 5 days from now, timeout would be 5 * 86400 * 1000 =
1860 * 432000000 ms for timeout.
1861 * <p>
1862 * To disable password expiration, a value of 0 may be used for timeout.
1863 * <p>
1864 * The calling device admin must have requested
1865 * {@link DeviceAdminInfo#USES_POLICY_EXPIRE_PASSWORD} to be able to call this method; if it has
1866 * not, a security exception will be thrown.
1867 * <p>
1868 * Note that setting the password will automatically reset the expiration time for all active
1869 * admins. Active admins do not need to explicitly call this method in that case.
1870 * <p>
1871 * This method can be called on the {@link DevicePolicyManager} instance returned by
1872 * {@link #getParentProfileInstance(ComponentName)} in order to set restrictions on the parent
1873 * profile.
Esteban Talaverac1c83592016-02-17 17:56:15 +00001874 *
Jim Millera4e28d12010-11-08 16:15:47 -08001875 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07001876 * @param timeout The limit (in ms) that a password can remain in effect. A value of 0 means
1877 * there is no restriction (unlimited).
1878 * @throws SecurityException if {@code admin} is not an active administrator or {@code admin}
1879 * does not use {@link DeviceAdminInfo#USES_POLICY_EXPIRE_PASSWORD}
Jim Millera4e28d12010-11-08 16:15:47 -08001880 */
Robin Lee25e26452015-06-02 09:56:29 -07001881 public void setPasswordExpirationTimeout(@NonNull ComponentName admin, long timeout) {
Jim Millera4e28d12010-11-08 16:15:47 -08001882 if (mService != null) {
1883 try {
Esteban Talavera62399912016-01-11 15:37:55 +00001884 mService.setPasswordExpirationTimeout(admin, timeout, mParentInstance);
Jim Millera4e28d12010-11-08 16:15:47 -08001885 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07001886 throw e.rethrowFromSystemServer();
Jim Millera4e28d12010-11-08 16:15:47 -08001887 }
1888 }
1889 }
1890
1891 /**
Jim Miller6b857682011-02-16 16:27:41 -08001892 * Get the password expiration timeout for the given admin. The expiration timeout is the
1893 * recurring expiration timeout provided in the call to
1894 * {@link #setPasswordExpirationTimeout(ComponentName, long)} for the given admin or the
Esteban Talaverac1c83592016-02-17 17:56:15 +00001895 * aggregate of all participating policy administrators if {@code admin} is null. Admins that
1896 * have set restrictions on profiles that have a separate challenge are not taken into account.
1897 *
1898 * <p>This method can be called on the {@link DevicePolicyManager} instance
1899 * returned by {@link #getParentProfileInstance(ComponentName)} in order to retrieve
1900 * restrictions on the parent profile.
Jim Millera4e28d12010-11-08 16:15:47 -08001901 *
Robin Lee25e26452015-06-02 09:56:29 -07001902 * @param admin The name of the admin component to check, or {@code null} to aggregate all admins.
Jim Millera4e28d12010-11-08 16:15:47 -08001903 * @return The timeout for the given admin or the minimum of all timeouts
1904 */
Robin Lee25e26452015-06-02 09:56:29 -07001905 public long getPasswordExpirationTimeout(@Nullable ComponentName admin) {
Jim Millera4e28d12010-11-08 16:15:47 -08001906 if (mService != null) {
1907 try {
Esteban Talavera62399912016-01-11 15:37:55 +00001908 return mService.getPasswordExpirationTimeout(admin, myUserId(), mParentInstance);
Jim Millera4e28d12010-11-08 16:15:47 -08001909 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07001910 throw e.rethrowFromSystemServer();
Jim Millera4e28d12010-11-08 16:15:47 -08001911 }
1912 }
1913 return 0;
1914 }
1915
1916 /**
Esteban Talaverac1c83592016-02-17 17:56:15 +00001917 * Get the current password expiration time for a particular admin or all admins that set
Rubin Xud3609d42016-07-13 18:32:57 +01001918 * restrictions on this user and its participating profiles. Restrictions on profiles that have
Esteban Talaverac1c83592016-02-17 17:56:15 +00001919 * a separate challenge are not taken into account. If admin is {@code null}, then a composite
1920 * of all expiration times is returned - which will be the minimum of all of them.
1921 *
1922 * <p>This method can be called on the {@link DevicePolicyManager} instance
1923 * returned by {@link #getParentProfileInstance(ComponentName)} in order to retrieve
1924 * the password expiration for the parent profile.
Jim Millera4e28d12010-11-08 16:15:47 -08001925 *
Robin Lee25e26452015-06-02 09:56:29 -07001926 * @param admin The name of the admin component to check, or {@code null} to aggregate all admins.
Esteban Talaverac1c83592016-02-17 17:56:15 +00001927 * @return The password expiration time, in milliseconds since epoch.
Jim Millera4e28d12010-11-08 16:15:47 -08001928 */
Robin Lee25e26452015-06-02 09:56:29 -07001929 public long getPasswordExpiration(@Nullable ComponentName admin) {
Jim Millera4e28d12010-11-08 16:15:47 -08001930 if (mService != null) {
1931 try {
Esteban Talavera62399912016-01-11 15:37:55 +00001932 return mService.getPasswordExpiration(admin, myUserId(), mParentInstance);
Jim Millera4e28d12010-11-08 16:15:47 -08001933 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07001934 throw e.rethrowFromSystemServer();
Jim Millera4e28d12010-11-08 16:15:47 -08001935 }
1936 }
1937 return 0;
1938 }
1939
1940 /**
Esteban Talaverac1c83592016-02-17 17:56:15 +00001941 * Retrieve the current password history length for a particular admin or all admins that
Rubin Xud3609d42016-07-13 18:32:57 +01001942 * set restrictions on this user and its participating profiles. Restrictions on profiles that
Esteban Talaverac1c83592016-02-17 17:56:15 +00001943 * have a separate challenge are not taken into account.
1944 *
1945 * <p>This method can be called on the {@link DevicePolicyManager} instance
1946 * returned by {@link #getParentProfileInstance(ComponentName)} in order to retrieve
1947 * restrictions on the parent profile.
1948 *
Robin Lee25e26452015-06-02 09:56:29 -07001949 * @param admin The name of the admin component to check, or {@code null} to aggregate
Konstantin Lopyrev32558232010-05-20 16:18:05 -07001950 * all admins.
1951 * @return The length of the password history
1952 */
Robin Lee25e26452015-06-02 09:56:29 -07001953 public int getPasswordHistoryLength(@Nullable ComponentName admin) {
Makoto Onukicc4bbeb2015-09-17 10:28:24 -07001954 return getPasswordHistoryLength(admin, myUserId());
Amith Yamasani599dd7c2012-09-14 23:20:08 -07001955 }
1956
1957 /** @hide per-user version */
Robin Lee25e26452015-06-02 09:56:29 -07001958 public int getPasswordHistoryLength(@Nullable ComponentName admin, int userHandle) {
Konstantin Lopyrev32558232010-05-20 16:18:05 -07001959 if (mService != null) {
1960 try {
Esteban Talavera62399912016-01-11 15:37:55 +00001961 return mService.getPasswordHistoryLength(admin, userHandle, mParentInstance);
Konstantin Lopyrev32558232010-05-20 16:18:05 -07001962 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07001963 throw e.rethrowFromSystemServer();
Konstantin Lopyrev32558232010-05-20 16:18:05 -07001964 }
1965 }
1966 return 0;
1967 }
1968
Dianne Hackbornd6847842010-01-12 18:14:19 -08001969 /**
Dianne Hackborn254cb442010-01-27 19:23:59 -08001970 * Return the maximum password length that the device supports for a
Dianne Hackborn9327f4f2010-01-29 10:38:29 -08001971 * particular password quality.
Dianne Hackborn364f6e32010-01-29 17:38:20 -08001972 * @param quality The quality being interrogated.
Dianne Hackborn254cb442010-01-27 19:23:59 -08001973 * @return Returns the maximum length that the user can enter.
1974 */
Dianne Hackborn9327f4f2010-01-29 10:38:29 -08001975 public int getPasswordMaximumLength(int quality) {
Dianne Hackborn254cb442010-01-27 19:23:59 -08001976 // Kind-of arbitrary.
1977 return 16;
1978 }
Konstantin Lopyrev32558232010-05-20 16:18:05 -07001979
Dianne Hackborn254cb442010-01-27 19:23:59 -08001980 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07001981 * Determine whether the current password the user has set is sufficient to meet the policy
1982 * requirements (e.g. quality, minimum length) that have been requested by the admins of this
1983 * user and its participating profiles. Restrictions on profiles that have a separate challenge
1984 * are not taken into account.
1985 * <p>
1986 * The calling device admin must have requested
1987 * {@link DeviceAdminInfo#USES_POLICY_LIMIT_PASSWORD} to be able to call this method; if it has
1988 * not, a security exception will be thrown.
1989 * <p>
1990 * This method can be called on the {@link DevicePolicyManager} instance returned by
1991 * {@link #getParentProfileInstance(ComponentName)} in order to determine if the password set on
1992 * the parent profile is sufficient.
Esteban Talaverac1c83592016-02-17 17:56:15 +00001993 *
Jessica Hummel91da58d2014-04-10 17:39:43 +01001994 * @return Returns true if the password meets the current requirements, else false.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07001995 * @throws SecurityException if the calling application does not own an active administrator
1996 * that uses {@link DeviceAdminInfo#USES_POLICY_LIMIT_PASSWORD}
Dianne Hackbornd6847842010-01-12 18:14:19 -08001997 */
Dianne Hackborndf83afa2010-01-20 13:37:26 -08001998 public boolean isActivePasswordSufficient() {
Dianne Hackbornd6847842010-01-12 18:14:19 -08001999 if (mService != null) {
2000 try {
Clara Bayarri3e826ef2015-12-14 17:51:22 +00002001 return mService.isActivePasswordSufficient(myUserId(), mParentInstance);
Dianne Hackbornd6847842010-01-12 18:14:19 -08002002 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07002003 throw e.rethrowFromSystemServer();
Dianne Hackbornd6847842010-01-12 18:14:19 -08002004 }
2005 }
Dianne Hackborndf83afa2010-01-20 13:37:26 -08002006 return false;
Dianne Hackbornd6847842010-01-12 18:14:19 -08002007 }
Konstantin Lopyrev32558232010-05-20 16:18:05 -07002008
Dianne Hackbornd6847842010-01-12 18:14:19 -08002009 /**
Clara Bayarrid7693912016-01-22 17:26:31 +00002010 * Determine whether the current profile password the user has set is sufficient
Esteban Talaverac1c83592016-02-17 17:56:15 +00002011 * to meet the policy requirements (e.g. quality, minimum length) that have been
Clara Bayarrid7693912016-01-22 17:26:31 +00002012 * requested by the admins of the parent user and its profiles.
2013 *
2014 * @param userHandle the userId of the profile to check the password for.
2015 * @return Returns true if the password would meet the current requirements, else false.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07002016 * @throws SecurityException if {@code userHandle} is not a managed profile.
Clara Bayarrid7693912016-01-22 17:26:31 +00002017 * @hide
2018 */
2019 public boolean isProfileActivePasswordSufficientForParent(int userHandle) {
2020 if (mService != null) {
2021 try {
2022 return mService.isProfileActivePasswordSufficientForParent(userHandle);
2023 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07002024 throw e.rethrowFromSystemServer();
Clara Bayarrid7693912016-01-22 17:26:31 +00002025 }
2026 }
2027 return false;
2028 }
2029
2030 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07002031 * Retrieve the number of times the user has failed at entering a password since that last
2032 * successful password entry.
2033 * <p>
2034 * This method can be called on the {@link DevicePolicyManager} instance returned by
2035 * {@link #getParentProfileInstance(ComponentName)} in order to retrieve the number of failed
2036 * password attemts for the parent user.
2037 * <p>
2038 * The calling device admin must have requested {@link DeviceAdminInfo#USES_POLICY_WATCH_LOGIN}
2039 * to be able to call this method; if it has not, a security exception will be thrown.
Konstantin Lopyrev32558232010-05-20 16:18:05 -07002040 *
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07002041 * @return The number of times user has entered an incorrect password since the last correct
2042 * password entry.
2043 * @throws SecurityException if the calling application does not own an active administrator
2044 * that uses {@link DeviceAdminInfo#USES_POLICY_WATCH_LOGIN}
Dianne Hackbornd6847842010-01-12 18:14:19 -08002045 */
2046 public int getCurrentFailedPasswordAttempts() {
Clara Bayarri51e41ad2016-02-11 17:48:53 +00002047 return getCurrentFailedPasswordAttempts(myUserId());
2048 }
2049
2050 /**
2051 * Retrieve the number of times the given user has failed at entering a
2052 * password since that last successful password entry.
2053 *
2054 * <p>The calling device admin must have requested
2055 * {@link DeviceAdminInfo#USES_POLICY_WATCH_LOGIN} to be able to call this method; if it has
2056 * not and it is not the system uid, a security exception will be thrown.
2057 *
2058 * @hide
2059 */
2060 public int getCurrentFailedPasswordAttempts(int userHandle) {
Dianne Hackbornd6847842010-01-12 18:14:19 -08002061 if (mService != null) {
2062 try {
Clara Bayarri51e41ad2016-02-11 17:48:53 +00002063 return mService.getCurrentFailedPasswordAttempts(userHandle, mParentInstance);
Dianne Hackbornd6847842010-01-12 18:14:19 -08002064 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07002065 throw e.rethrowFromSystemServer();
Dianne Hackbornd6847842010-01-12 18:14:19 -08002066 }
2067 }
2068 return -1;
2069 }
Dianne Hackborndf83afa2010-01-20 13:37:26 -08002070
2071 /**
Craig Lafayette4e401fa2015-05-07 10:24:02 -04002072 * Queries whether {@link #RESET_PASSWORD_DO_NOT_ASK_CREDENTIALS_ON_BOOT} flag is set.
Andrei Kapishnikov4eb6a362015-04-02 15:21:20 -04002073 *
Craig Lafayette4e401fa2015-05-07 10:24:02 -04002074 * @return true if RESET_PASSWORD_DO_NOT_ASK_CREDENTIALS_ON_BOOT flag is set.
Andrei Kapishnikov4eb6a362015-04-02 15:21:20 -04002075 * @hide
2076 */
2077 public boolean getDoNotAskCredentialsOnBoot() {
2078 if (mService != null) {
2079 try {
2080 return mService.getDoNotAskCredentialsOnBoot();
2081 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07002082 throw e.rethrowFromSystemServer();
Andrei Kapishnikov4eb6a362015-04-02 15:21:20 -04002083 }
2084 }
2085 return false;
2086 }
2087
2088 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07002089 * Setting this to a value greater than zero enables a built-in policy that will perform a
2090 * device or profile wipe after too many incorrect device-unlock passwords have been entered.
2091 * This built-in policy combines watching for failed passwords and wiping the device, and
2092 * requires that you request both {@link DeviceAdminInfo#USES_POLICY_WATCH_LOGIN} and
Dianne Hackborn8ea138c2010-01-26 18:01:04 -08002093 * {@link DeviceAdminInfo#USES_POLICY_WIPE_DATA}}.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07002094 * <p>
2095 * To implement any other policy (e.g. wiping data for a particular application only, erasing or
2096 * revoking credentials, or reporting the failure to a server), you should implement
2097 * {@link DeviceAdminReceiver#onPasswordFailed(Context, android.content.Intent)} instead. Do not
2098 * use this API, because if the maximum count is reached, the device or profile will be wiped
2099 * immediately, and your callback will not be invoked.
2100 * <p>
2101 * This method can be called on the {@link DevicePolicyManager} instance returned by
2102 * {@link #getParentProfileInstance(ComponentName)} in order to set a value on the parent
2103 * profile.
Konstantin Lopyrev32558232010-05-20 16:18:05 -07002104 *
Dianne Hackbornef6b22f2010-02-16 20:38:49 -08002105 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07002106 * @param num The number of failed password attempts at which point the device or profile will
2107 * be wiped.
2108 * @throws SecurityException if {@code admin} is not an active administrator or does not use
2109 * both {@link DeviceAdminInfo#USES_POLICY_WATCH_LOGIN} and
2110 * {@link DeviceAdminInfo#USES_POLICY_WIPE_DATA}.
Dianne Hackborn8ea138c2010-01-26 18:01:04 -08002111 */
Robin Lee25e26452015-06-02 09:56:29 -07002112 public void setMaximumFailedPasswordsForWipe(@NonNull ComponentName admin, int num) {
Dianne Hackborn8ea138c2010-01-26 18:01:04 -08002113 if (mService != null) {
2114 try {
Esteban Talavera62399912016-01-11 15:37:55 +00002115 mService.setMaximumFailedPasswordsForWipe(admin, num, mParentInstance);
Dianne Hackborn8ea138c2010-01-26 18:01:04 -08002116 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07002117 throw e.rethrowFromSystemServer();
Dianne Hackborn8ea138c2010-01-26 18:01:04 -08002118 }
2119 }
2120 }
Konstantin Lopyrev32558232010-05-20 16:18:05 -07002121
Dianne Hackborn8ea138c2010-01-26 18:01:04 -08002122 /**
Esteban Talaverac1c83592016-02-17 17:56:15 +00002123 * Retrieve the current maximum number of login attempts that are allowed before the device
Rubin Xud3609d42016-07-13 18:32:57 +01002124 * or profile is wiped, for a particular admin or all admins that set restrictions on this user
Esteban Talaverac1c83592016-02-17 17:56:15 +00002125 * and its participating profiles. Restrictions on profiles that have a separate challenge are
2126 * not taken into account.
2127 *
2128 * <p>This method can be called on the {@link DevicePolicyManager} instance
2129 * returned by {@link #getParentProfileInstance(ComponentName)} in order to retrieve
2130 * the value for the parent profile.
2131 *
Robin Lee25e26452015-06-02 09:56:29 -07002132 * @param admin The name of the admin component to check, or {@code null} to aggregate
Dianne Hackborn254cb442010-01-27 19:23:59 -08002133 * all admins.
2134 */
Robin Lee25e26452015-06-02 09:56:29 -07002135 public int getMaximumFailedPasswordsForWipe(@Nullable ComponentName admin) {
Makoto Onukicc4bbeb2015-09-17 10:28:24 -07002136 return getMaximumFailedPasswordsForWipe(admin, myUserId());
Amith Yamasani599dd7c2012-09-14 23:20:08 -07002137 }
2138
2139 /** @hide per-user version */
Robin Lee25e26452015-06-02 09:56:29 -07002140 public int getMaximumFailedPasswordsForWipe(@Nullable ComponentName admin, int userHandle) {
Dianne Hackborn254cb442010-01-27 19:23:59 -08002141 if (mService != null) {
2142 try {
Esteban Talavera62399912016-01-11 15:37:55 +00002143 return mService.getMaximumFailedPasswordsForWipe(
2144 admin, userHandle, mParentInstance);
Dianne Hackborn254cb442010-01-27 19:23:59 -08002145 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07002146 throw e.rethrowFromSystemServer();
Dianne Hackborn254cb442010-01-27 19:23:59 -08002147 }
2148 }
2149 return 0;
2150 }
Konstantin Lopyrev32558232010-05-20 16:18:05 -07002151
Dianne Hackborn254cb442010-01-27 19:23:59 -08002152 /**
Amith Yamasani3a3d2122014-10-29 11:41:31 -07002153 * Returns the profile with the smallest maximum failed passwords for wipe,
2154 * for the given user. So for primary user, it might return the primary or
2155 * a managed profile. For a secondary user, it would be the same as the
2156 * user passed in.
2157 * @hide Used only by Keyguard
2158 */
2159 public int getProfileWithMinimumFailedPasswordsForWipe(int userHandle) {
2160 if (mService != null) {
2161 try {
Esteban Talavera62399912016-01-11 15:37:55 +00002162 return mService.getProfileWithMinimumFailedPasswordsForWipe(
2163 userHandle, mParentInstance);
Amith Yamasani3a3d2122014-10-29 11:41:31 -07002164 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07002165 throw e.rethrowFromSystemServer();
Amith Yamasani3a3d2122014-10-29 11:41:31 -07002166 }
2167 }
2168 return UserHandle.USER_NULL;
2169 }
2170
2171 /**
Dianne Hackborn87bba1e2010-02-26 17:25:54 -08002172 * Flag for {@link #resetPassword}: don't allow other admins to change
2173 * the password again until the user has entered it.
2174 */
2175 public static final int RESET_PASSWORD_REQUIRE_ENTRY = 0x0001;
Konstantin Lopyrev32558232010-05-20 16:18:05 -07002176
Dianne Hackborn87bba1e2010-02-26 17:25:54 -08002177 /**
Andrei Kapishnikov4eb6a362015-04-02 15:21:20 -04002178 * Flag for {@link #resetPassword}: don't ask for user credentials on device boot.
2179 * If the flag is set, the device can be booted without asking for user password.
2180 * The absence of this flag does not change the current boot requirements. This flag
2181 * can be set by the device owner only. If the app is not the device owner, the flag
2182 * is ignored. Once the flag is set, it cannot be reverted back without resetting the
2183 * device to factory defaults.
2184 */
Craig Lafayette4e401fa2015-05-07 10:24:02 -04002185 public static final int RESET_PASSWORD_DO_NOT_ASK_CREDENTIALS_ON_BOOT = 0x0002;
Andrei Kapishnikov4eb6a362015-04-02 15:21:20 -04002186
2187 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07002188 * Force a new device unlock password (the password needed to access the entire device, not for
2189 * individual accounts) on the user. This takes effect immediately.
2190 * <p>
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07002191 * <em>Note: This API has been limited as of {@link android.os.Build.VERSION_CODES#N} for
Makoto Onuki70f929e2015-11-11 12:40:15 -08002192 * device admins that are not device owner and not profile owner.
2193 * The password can now only be changed if there is currently no password set. Device owner
Ricky Wai977ade22016-05-24 15:02:41 +01002194 * and profile owner can still do this when user is unlocked and does not have a managed
2195 * profile.</em>
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07002196 * <p>
2197 * The given password must be sufficient for the current password quality and length constraints
2198 * as returned by {@link #getPasswordQuality(ComponentName)} and
2199 * {@link #getPasswordMinimumLength(ComponentName)}; if it does not meet these constraints, then
2200 * it will be rejected and false returned. Note that the password may be a stronger quality
2201 * (containing alphanumeric characters when the requested quality is only numeric), in which
2202 * case the currently active quality will be increased to match.
2203 * <p>
2204 * Calling with a null or empty password will clear any existing PIN, pattern or password if the
Robin Leece5c4002016-03-23 17:05:03 +00002205 * current password constraints allow it. <em>Note: This will not work in
2206 * {@link android.os.Build.VERSION_CODES#N} and later for managed profiles, or for device admins
2207 * that are not device owner or profile owner. Once set, the password cannot be changed to null
2208 * or empty except by these admins.</em>
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07002209 * <p>
2210 * The calling device admin must have requested
2211 * {@link DeviceAdminInfo#USES_POLICY_RESET_PASSWORD} to be able to call this method; if it has
2212 * not, a security exception will be thrown.
Konstantin Lopyrev32558232010-05-20 16:18:05 -07002213 *
Adrian Roosf8f56bc2014-11-20 23:55:34 +01002214 * @param password The new password for the user. Null or empty clears the password.
Andrei Kapishnikov4eb6a362015-04-02 15:21:20 -04002215 * @param flags May be 0 or combination of {@link #RESET_PASSWORD_REQUIRE_ENTRY} and
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07002216 * {@link #RESET_PASSWORD_DO_NOT_ASK_CREDENTIALS_ON_BOOT}.
2217 * @return Returns true if the password was applied, or false if it is not acceptable for the
2218 * current constraints or if the user has not been decrypted yet.
2219 * @throws SecurityException if the calling application does not own an active administrator
2220 * that uses {@link DeviceAdminInfo#USES_POLICY_RESET_PASSWORD}
Ricky Wai977ade22016-05-24 15:02:41 +01002221 * @throws IllegalStateException if the calling user is locked or has a managed profile.
Dianne Hackborndf83afa2010-01-20 13:37:26 -08002222 */
Dianne Hackborn87bba1e2010-02-26 17:25:54 -08002223 public boolean resetPassword(String password, int flags) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01002224 throwIfParentInstance("resetPassword");
Dianne Hackborndf83afa2010-01-20 13:37:26 -08002225 if (mService != null) {
2226 try {
Fyodor Kupolovbdc58c62015-01-29 13:24:03 -08002227 return mService.resetPassword(password, flags);
Dianne Hackborndf83afa2010-01-20 13:37:26 -08002228 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07002229 throw e.rethrowFromSystemServer();
Dianne Hackborndf83afa2010-01-20 13:37:26 -08002230 }
2231 }
2232 return false;
2233 }
Konstantin Lopyrev32558232010-05-20 16:18:05 -07002234
Dianne Hackbornd6847842010-01-12 18:14:19 -08002235 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07002236 * Called by an application that is administering the device to set the maximum time for user
2237 * activity until the device will lock. This limits the length that the user can set. It takes
2238 * effect immediately.
2239 * <p>
2240 * The calling device admin must have requested {@link DeviceAdminInfo#USES_POLICY_FORCE_LOCK}
2241 * to be able to call this method; if it has not, a security exception will be thrown.
2242 * <p>
2243 * This method can be called on the {@link DevicePolicyManager} instance returned by
2244 * {@link #getParentProfileInstance(ComponentName)} in order to set restrictions on the parent
2245 * profile.
Esteban Talaverac1c83592016-02-17 17:56:15 +00002246 *
Dianne Hackbornef6b22f2010-02-16 20:38:49 -08002247 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07002248 * @param timeMs The new desired maximum time to lock in milliseconds. A value of 0 means there
2249 * is no restriction.
2250 * @throws SecurityException if {@code admin} is not an active administrator or it does not use
2251 * {@link DeviceAdminInfo#USES_POLICY_FORCE_LOCK}
Dianne Hackbornd6847842010-01-12 18:14:19 -08002252 */
Robin Lee25e26452015-06-02 09:56:29 -07002253 public void setMaximumTimeToLock(@NonNull ComponentName admin, long timeMs) {
Dianne Hackbornd6847842010-01-12 18:14:19 -08002254 if (mService != null) {
2255 try {
Esteban Talavera62399912016-01-11 15:37:55 +00002256 mService.setMaximumTimeToLock(admin, timeMs, mParentInstance);
Dianne Hackbornd6847842010-01-12 18:14:19 -08002257 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07002258 throw e.rethrowFromSystemServer();
Dianne Hackbornd6847842010-01-12 18:14:19 -08002259 }
2260 }
2261 }
Konstantin Lopyrev32558232010-05-20 16:18:05 -07002262
Dianne Hackbornd6847842010-01-12 18:14:19 -08002263 /**
Esteban Talaverac1c83592016-02-17 17:56:15 +00002264 * Retrieve the current maximum time to unlock for a particular admin or all admins that set
Rubin Xud3609d42016-07-13 18:32:57 +01002265 * restrictions on this user and its participating profiles. Restrictions on profiles that have
Esteban Talaverac1c83592016-02-17 17:56:15 +00002266 * a separate challenge are not taken into account.
2267 *
2268 * <p>This method can be called on the {@link DevicePolicyManager} instance
2269 * returned by {@link #getParentProfileInstance(ComponentName)} in order to retrieve
2270 * restrictions on the parent profile.
2271 *
Robin Lee25e26452015-06-02 09:56:29 -07002272 * @param admin The name of the admin component to check, or {@code null} to aggregate
Dianne Hackborn254cb442010-01-27 19:23:59 -08002273 * all admins.
Jim Millerd4efaac2014-08-14 18:02:45 -07002274 * @return time in milliseconds for the given admin or the minimum value (strictest) of
Jim Miller76b9b8b2014-08-22 17:04:57 -07002275 * all admins if admin is null. Returns 0 if there are no restrictions.
Dianne Hackbornd6847842010-01-12 18:14:19 -08002276 */
Robin Lee25e26452015-06-02 09:56:29 -07002277 public long getMaximumTimeToLock(@Nullable ComponentName admin) {
Makoto Onukicc4bbeb2015-09-17 10:28:24 -07002278 return getMaximumTimeToLock(admin, myUserId());
Amith Yamasani599dd7c2012-09-14 23:20:08 -07002279 }
2280
2281 /** @hide per-user version */
Robin Lee25e26452015-06-02 09:56:29 -07002282 public long getMaximumTimeToLock(@Nullable ComponentName admin, int userHandle) {
Dianne Hackbornd6847842010-01-12 18:14:19 -08002283 if (mService != null) {
2284 try {
Esteban Talavera62399912016-01-11 15:37:55 +00002285 return mService.getMaximumTimeToLock(admin, userHandle, mParentInstance);
Dianne Hackbornd6847842010-01-12 18:14:19 -08002286 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07002287 throw e.rethrowFromSystemServer();
Dianne Hackbornd6847842010-01-12 18:14:19 -08002288 }
2289 }
2290 return 0;
2291 }
Konstantin Lopyrev32558232010-05-20 16:18:05 -07002292
Dianne Hackbornd6847842010-01-12 18:14:19 -08002293 /**
Ricky Wai035e9242016-03-18 16:43:31 +00002294 * Returns maximum time to lock that applied by all profiles in this user. We do this because we
2295 * do not have a separate timeout to lock for work challenge only.
2296 *
2297 * @hide
2298 */
2299 public long getMaximumTimeToLockForUserAndProfiles(int userHandle) {
2300 if (mService != null) {
2301 try {
2302 return mService.getMaximumTimeToLockForUserAndProfiles(userHandle);
2303 } catch (RemoteException e) {
2304 throw e.rethrowFromSystemServer();
2305 }
2306 }
2307 return 0;
2308 }
2309
2310 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07002311 * Make the device lock immediately, as if the lock screen timeout has expired at the point of
2312 * this call.
2313 * <p>
2314 * The calling device admin must have requested {@link DeviceAdminInfo#USES_POLICY_FORCE_LOCK}
2315 * to be able to call this method; if it has not, a security exception will be thrown.
2316 * <p>
2317 * This method can be called on the {@link DevicePolicyManager} instance returned by
2318 * {@link #getParentProfileInstance(ComponentName)} in order to lock the parent profile.
Konstantin Lopyrev32558232010-05-20 16:18:05 -07002319 *
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07002320 * @throws SecurityException if the calling application does not own an active administrator
2321 * that uses {@link DeviceAdminInfo#USES_POLICY_FORCE_LOCK}
Dianne Hackbornd6847842010-01-12 18:14:19 -08002322 */
Dianne Hackborndf83afa2010-01-20 13:37:26 -08002323 public void lockNow() {
2324 if (mService != null) {
2325 try {
Esteban Talavera62399912016-01-11 15:37:55 +00002326 mService.lockNow(mParentInstance);
Dianne Hackborndf83afa2010-01-20 13:37:26 -08002327 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07002328 throw e.rethrowFromSystemServer();
Dianne Hackborndf83afa2010-01-20 13:37:26 -08002329 }
2330 }
2331 }
Konstantin Lopyrev32558232010-05-20 16:18:05 -07002332
Dianne Hackbornd6847842010-01-12 18:14:19 -08002333 /**
Dianne Hackborn42499172010-10-15 18:45:07 -07002334 * Flag for {@link #wipeData(int)}: also erase the device's external
Paul Crowleya7e87ac2014-11-18 13:50:19 +00002335 * storage (such as SD cards).
Dianne Hackborn42499172010-10-15 18:45:07 -07002336 */
2337 public static final int WIPE_EXTERNAL_STORAGE = 0x0001;
2338
2339 /**
Paul Crowleya7e87ac2014-11-18 13:50:19 +00002340 * Flag for {@link #wipeData(int)}: also erase the factory reset protection
2341 * data.
2342 *
Paul Crowley2934b262014-12-02 11:21:13 +00002343 * <p>This flag may only be set by device owner admins; if it is set by
2344 * other admins a {@link SecurityException} will be thrown.
Paul Crowleya7e87ac2014-11-18 13:50:19 +00002345 */
2346 public static final int WIPE_RESET_PROTECTION_DATA = 0x0002;
2347
2348 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07002349 * Ask the user data be wiped. Wiping the primary user will cause the device to reboot, erasing
2350 * all user data while next booting up.
2351 * <p>
2352 * The calling device admin must have requested {@link DeviceAdminInfo#USES_POLICY_WIPE_DATA} to
2353 * be able to call this method; if it has not, a security exception will be thrown.
Konstantin Lopyrev32558232010-05-20 16:18:05 -07002354 *
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07002355 * @param flags Bit mask of additional options: currently supported flags are
2356 * {@link #WIPE_EXTERNAL_STORAGE} and {@link #WIPE_RESET_PROTECTION_DATA}.
2357 * @throws SecurityException if the calling application does not own an active administrator
2358 * that uses {@link DeviceAdminInfo#USES_POLICY_WIPE_DATA}
Dianne Hackbornd6847842010-01-12 18:14:19 -08002359 */
2360 public void wipeData(int flags) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01002361 throwIfParentInstance("wipeData");
Dianne Hackbornd6847842010-01-12 18:14:19 -08002362 if (mService != null) {
2363 try {
Makoto Onuki70f929e2015-11-11 12:40:15 -08002364 mService.wipeData(flags);
Dianne Hackbornd6847842010-01-12 18:14:19 -08002365 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07002366 throw e.rethrowFromSystemServer();
Dianne Hackbornd6847842010-01-12 18:14:19 -08002367 }
2368 }
2369 }
Konstantin Lopyrev32558232010-05-20 16:18:05 -07002370
Dianne Hackbornd6847842010-01-12 18:14:19 -08002371 /**
Oscar Montemayor69238c62010-08-03 10:51:06 -07002372 * Called by an application that is administering the device to set the
2373 * global proxy and exclusion list.
2374 * <p>
2375 * The calling device admin must have requested
2376 * {@link DeviceAdminInfo#USES_POLICY_SETS_GLOBAL_PROXY} to be able to call
2377 * this method; if it has not, a security exception will be thrown.
2378 * Only the first device admin can set the proxy. If a second admin attempts
2379 * to set the proxy, the {@link ComponentName} of the admin originally setting the
Robin Lee25e26452015-06-02 09:56:29 -07002380 * proxy will be returned. If successful in setting the proxy, {@code null} will
Oscar Montemayor69238c62010-08-03 10:51:06 -07002381 * be returned.
2382 * The method can be called repeatedly by the device admin alrady setting the
2383 * proxy to update the proxy and exclusion list.
2384 *
Robin Lee25e26452015-06-02 09:56:29 -07002385 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
Oscar Montemayor69238c62010-08-03 10:51:06 -07002386 * @param proxySpec the global proxy desired. Must be an HTTP Proxy.
2387 * Pass Proxy.NO_PROXY to reset the proxy.
2388 * @param exclusionList a list of domains to be excluded from the global proxy.
Robin Lee25e26452015-06-02 09:56:29 -07002389 * @return {@code null} if the proxy was successfully set, or otherwise a {@link ComponentName}
2390 * of the device admin that sets the proxy.
Andy Stadlerd2672722011-02-16 10:53:33 -08002391 * @hide
Oscar Montemayor69238c62010-08-03 10:51:06 -07002392 */
Robin Lee25e26452015-06-02 09:56:29 -07002393 public ComponentName setGlobalProxy(@NonNull ComponentName admin, Proxy proxySpec,
Oscar Montemayor69238c62010-08-03 10:51:06 -07002394 List<String> exclusionList ) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01002395 throwIfParentInstance("setGlobalProxy");
Oscar Montemayor69238c62010-08-03 10:51:06 -07002396 if (proxySpec == null) {
2397 throw new NullPointerException();
2398 }
2399 if (mService != null) {
2400 try {
2401 String hostSpec;
2402 String exclSpec;
2403 if (proxySpec.equals(Proxy.NO_PROXY)) {
2404 hostSpec = null;
2405 exclSpec = null;
2406 } else {
2407 if (!proxySpec.type().equals(Proxy.Type.HTTP)) {
2408 throw new IllegalArgumentException();
2409 }
2410 InetSocketAddress sa = (InetSocketAddress)proxySpec.address();
2411 String hostName = sa.getHostName();
2412 int port = sa.getPort();
2413 StringBuilder hostBuilder = new StringBuilder();
2414 hostSpec = hostBuilder.append(hostName)
2415 .append(":").append(Integer.toString(port)).toString();
2416 if (exclusionList == null) {
2417 exclSpec = "";
2418 } else {
2419 StringBuilder listBuilder = new StringBuilder();
2420 boolean firstDomain = true;
2421 for (String exclDomain : exclusionList) {
2422 if (!firstDomain) {
2423 listBuilder = listBuilder.append(",");
2424 } else {
2425 firstDomain = false;
2426 }
2427 listBuilder = listBuilder.append(exclDomain.trim());
2428 }
2429 exclSpec = listBuilder.toString();
2430 }
Yuhao Zheng90704842014-02-28 17:22:45 -08002431 if (android.net.Proxy.validate(hostName, Integer.toString(port), exclSpec)
2432 != android.net.Proxy.PROXY_VALID)
2433 throw new IllegalArgumentException();
Oscar Montemayor69238c62010-08-03 10:51:06 -07002434 }
Fyodor Kupolovbdc58c62015-01-29 13:24:03 -08002435 return mService.setGlobalProxy(admin, hostSpec, exclSpec);
Oscar Montemayor69238c62010-08-03 10:51:06 -07002436 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07002437 throw e.rethrowFromSystemServer();
Oscar Montemayor69238c62010-08-03 10:51:06 -07002438 }
2439 }
2440 return null;
2441 }
2442
2443 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07002444 * Set a network-independent global HTTP proxy. This is not normally what you want for typical
2445 * HTTP proxies - they are generally network dependent. However if you're doing something
2446 * unusual like general internal filtering this may be useful. On a private network where the
2447 * proxy is not accessible, you may break HTTP using this.
2448 * <p>
2449 * This method requires the caller to be the device owner.
2450 * <p>
2451 * This proxy is only a recommendation and it is possible that some apps will ignore it.
Jason Monk03bc9912014-05-13 09:44:57 -04002452 *
Jason Monk03bc9912014-05-13 09:44:57 -04002453 * @see ProxyInfo
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07002454 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
2455 * @param proxyInfo The a {@link ProxyInfo} object defining the new global HTTP proxy. A
2456 * {@code null} value will clear the global HTTP proxy.
2457 * @throws SecurityException if {@code admin} is not the device owner.
Jason Monk03bc9912014-05-13 09:44:57 -04002458 */
Robin Lee25e26452015-06-02 09:56:29 -07002459 public void setRecommendedGlobalProxy(@NonNull ComponentName admin, @Nullable ProxyInfo
2460 proxyInfo) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01002461 throwIfParentInstance("setRecommendedGlobalProxy");
Jason Monk03bc9912014-05-13 09:44:57 -04002462 if (mService != null) {
2463 try {
2464 mService.setRecommendedGlobalProxy(admin, proxyInfo);
2465 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07002466 throw e.rethrowFromSystemServer();
Jason Monk03bc9912014-05-13 09:44:57 -04002467 }
2468 }
2469 }
2470
2471 /**
Oscar Montemayor69238c62010-08-03 10:51:06 -07002472 * Returns the component name setting the global proxy.
Robin Lee25e26452015-06-02 09:56:29 -07002473 * @return ComponentName object of the device admin that set the global proxy, or {@code null}
2474 * if no admin has set the proxy.
Andy Stadlerd2672722011-02-16 10:53:33 -08002475 * @hide
Oscar Montemayor69238c62010-08-03 10:51:06 -07002476 */
2477 public ComponentName getGlobalProxyAdmin() {
2478 if (mService != null) {
2479 try {
Makoto Onukicc4bbeb2015-09-17 10:28:24 -07002480 return mService.getGlobalProxyAdmin(myUserId());
Oscar Montemayor69238c62010-08-03 10:51:06 -07002481 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07002482 throw e.rethrowFromSystemServer();
Oscar Montemayor69238c62010-08-03 10:51:06 -07002483 }
2484 }
2485 return null;
2486 }
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 not supported.
2491 */
2492 public static final int ENCRYPTION_STATUS_UNSUPPORTED = 0;
2493
2494 /**
Andy Stadler22dbfda2011-01-17 12:47:31 -08002495 * Result code for {@link #setStorageEncryption} and {@link #getStorageEncryptionStatus}:
Andy Stadler7b0f8f02011-01-12 14:59:52 -08002496 * indicating that encryption is supported, but is not currently active.
2497 */
2498 public static final int ENCRYPTION_STATUS_INACTIVE = 1;
2499
2500 /**
Robin Lee3795fb02015-02-16 14:17:23 +00002501 * Result code for {@link #getStorageEncryptionStatus}:
Andy Stadler7b0f8f02011-01-12 14:59:52 -08002502 * indicating that encryption is not currently active, but is currently
2503 * being activated. This is only reported by devices that support
2504 * encryption of data and only when the storage is currently
2505 * undergoing a process of becoming encrypted. A device that must reboot and/or wipe data
2506 * to become encrypted will never return this value.
2507 */
Andy Stadler22dbfda2011-01-17 12:47:31 -08002508 public static final int ENCRYPTION_STATUS_ACTIVATING = 2;
Andy Stadler7b0f8f02011-01-12 14:59:52 -08002509
2510 /**
Andy Stadler22dbfda2011-01-17 12:47:31 -08002511 * Result code for {@link #setStorageEncryption} and {@link #getStorageEncryptionStatus}:
Andy Stadler7b0f8f02011-01-12 14:59:52 -08002512 * indicating that encryption is active.
Amith Yamasani75db1252016-07-11 14:41:01 -07002513 * <p>
2514 * Also see {@link #ENCRYPTION_STATUS_ACTIVE_PER_USER}.
Andy Stadler7b0f8f02011-01-12 14:59:52 -08002515 */
Andy Stadler22dbfda2011-01-17 12:47:31 -08002516 public static final int ENCRYPTION_STATUS_ACTIVE = 3;
Andy Stadler7b0f8f02011-01-12 14:59:52 -08002517
2518 /**
Robin Lee3795fb02015-02-16 14:17:23 +00002519 * Result code for {@link #getStorageEncryptionStatus}:
2520 * indicating that encryption is active, but an encryption key has not
2521 * been set by the user.
2522 */
2523 public static final int ENCRYPTION_STATUS_ACTIVE_DEFAULT_KEY = 4;
2524
2525 /**
Makoto Onukid4c9e542016-02-25 18:17:30 -08002526 * Result code for {@link #getStorageEncryptionStatus}:
Amith Yamasani75db1252016-07-11 14:41:01 -07002527 * indicating that encryption is active and the encryption key is tied to the user or profile.
2528 * <p>
2529 * This value is only returned to apps targeting API level 24 and above. For apps targeting
2530 * earlier API levels, {@link #ENCRYPTION_STATUS_ACTIVE} is returned, even if the
2531 * encryption key is specific to the user or profile.
Makoto Onukid4c9e542016-02-25 18:17:30 -08002532 */
2533 public static final int ENCRYPTION_STATUS_ACTIVE_PER_USER = 5;
2534
2535 /**
Andy Stadler7b0f8f02011-01-12 14:59:52 -08002536 * Activity action: begin the process of encrypting data on the device. This activity should
2537 * be launched after using {@link #setStorageEncryption} to request encryption be activated.
2538 * After resuming from this activity, use {@link #getStorageEncryption}
2539 * to check encryption status. However, on some devices this activity may never return, as
2540 * it may trigger a reboot and in some cases a complete data wipe of the device.
2541 */
2542 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
2543 public static final String ACTION_START_ENCRYPTION
2544 = "android.app.action.START_ENCRYPTION";
Andy Stadler7b0f8f02011-01-12 14:59:52 -08002545 /**
Jim Millerb8ec4702012-08-31 17:19:10 -07002546 * Widgets are enabled in keyguard
2547 */
Jim Miller48b9b0d2012-09-19 23:16:50 -07002548 public static final int KEYGUARD_DISABLE_FEATURES_NONE = 0;
Jim Millerb8ec4702012-08-31 17:19:10 -07002549
2550 /**
Jim Miller50e62182014-04-23 17:25:00 -07002551 * Disable all keyguard widgets. Has no effect.
Jim Millerb8ec4702012-08-31 17:19:10 -07002552 */
Jim Miller48b9b0d2012-09-19 23:16:50 -07002553 public static final int KEYGUARD_DISABLE_WIDGETS_ALL = 1 << 0;
2554
2555 /**
2556 * Disable the camera on secure keyguard screens (e.g. PIN/Pattern/Password)
2557 */
2558 public static final int KEYGUARD_DISABLE_SECURE_CAMERA = 1 << 1;
2559
2560 /**
Jim Miller50e62182014-04-23 17:25:00 -07002561 * Disable showing all notifications on secure keyguard screens (e.g. PIN/Pattern/Password)
2562 */
2563 public static final int KEYGUARD_DISABLE_SECURE_NOTIFICATIONS = 1 << 2;
2564
2565 /**
2566 * Only allow redacted notifications on secure keyguard screens (e.g. PIN/Pattern/Password)
2567 */
2568 public static final int KEYGUARD_DISABLE_UNREDACTED_NOTIFICATIONS = 1 << 3;
2569
2570 /**
Adrian Roosa06d5ca2014-07-28 15:14:21 +02002571 * Ignore trust agent state on secure keyguard screens
Jim Miller50e62182014-04-23 17:25:00 -07002572 * (e.g. PIN/Pattern/Password).
2573 */
2574 public static final int KEYGUARD_DISABLE_TRUST_AGENTS = 1 << 4;
2575
2576 /**
Jim Miller06e34502014-07-17 14:46:05 -07002577 * Disable fingerprint sensor on keyguard secure screens (e.g. PIN/Pattern/Password).
2578 */
2579 public static final int KEYGUARD_DISABLE_FINGERPRINT = 1 << 5;
2580
2581 /**
Adrian Roos7f06eed2016-02-05 15:21:02 -08002582 * Disable text entry into notifications on secure keyguard screens (e.g. PIN/Pattern/Password).
2583 */
2584 public static final int KEYGUARD_DISABLE_REMOTE_INPUT = 1 << 6;
2585
2586 /**
Jim Miller35207742012-11-02 15:33:20 -07002587 * Disable all current and future keyguard customizations.
Jim Miller48b9b0d2012-09-19 23:16:50 -07002588 */
2589 public static final int KEYGUARD_DISABLE_FEATURES_ALL = 0x7fffffff;
Jim Millerb8ec4702012-08-31 17:19:10 -07002590
2591 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07002592 * Called by an application that is administering the device to request that the storage system
2593 * be encrypted.
2594 * <p>
2595 * When multiple device administrators attempt to control device encryption, the most secure,
2596 * supported setting will always be used. If any device administrator requests device
2597 * encryption, it will be enabled; Conversely, if a device administrator attempts to disable
2598 * device encryption while another device administrator has enabled it, the call to disable will
Andy Stadler7b0f8f02011-01-12 14:59:52 -08002599 * fail (most commonly returning {@link #ENCRYPTION_STATUS_ACTIVE}).
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07002600 * <p>
2601 * This policy controls encryption of the secure (application data) storage area. Data written
2602 * to other storage areas may or may not be encrypted, and this policy does not require or
2603 * control the encryption of any other storage areas. There is one exception: If
2604 * {@link android.os.Environment#isExternalStorageEmulated()} is {@code true}, then the
2605 * directory returned by {@link android.os.Environment#getExternalStorageDirectory()} must be
2606 * written to disk within the encrypted storage area.
2607 * <p>
2608 * Important Note: On some devices, it is possible to encrypt storage without requiring the user
2609 * to create a device PIN or Password. In this case, the storage is encrypted, but the
2610 * encryption key may not be fully secured. For maximum security, the administrator should also
2611 * require (and check for) a pattern, PIN, or password.
Andy Stadler7b0f8f02011-01-12 14:59:52 -08002612 *
2613 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
2614 * @param encrypt true to request encryption, false to release any previous request
Andy Stadler22dbfda2011-01-17 12:47:31 -08002615 * @return the new request status (for all active admins) - will be one of
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07002616 * {@link #ENCRYPTION_STATUS_UNSUPPORTED}, {@link #ENCRYPTION_STATUS_INACTIVE}, or
2617 * {@link #ENCRYPTION_STATUS_ACTIVE}. This is the value of the requests; Use
2618 * {@link #getStorageEncryptionStatus()} to query the actual device state.
2619 * @throws SecurityException if {@code admin} is not an active administrator or does not use
2620 * {@link DeviceAdminInfo#USES_ENCRYPTED_STORAGE}
Andy Stadler7b0f8f02011-01-12 14:59:52 -08002621 */
Robin Lee25e26452015-06-02 09:56:29 -07002622 public int setStorageEncryption(@NonNull ComponentName admin, boolean encrypt) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01002623 throwIfParentInstance("setStorageEncryption");
Andy Stadler7b0f8f02011-01-12 14:59:52 -08002624 if (mService != null) {
2625 try {
Fyodor Kupolovbdc58c62015-01-29 13:24:03 -08002626 return mService.setStorageEncryption(admin, encrypt);
Andy Stadler7b0f8f02011-01-12 14:59:52 -08002627 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07002628 throw e.rethrowFromSystemServer();
Andy Stadler7b0f8f02011-01-12 14:59:52 -08002629 }
2630 }
2631 return ENCRYPTION_STATUS_UNSUPPORTED;
2632 }
2633
2634 /**
2635 * Called by an application that is administering the device to
Andy Stadler22dbfda2011-01-17 12:47:31 -08002636 * determine the requested setting for secure storage.
Andy Stadler7b0f8f02011-01-12 14:59:52 -08002637 *
Andy Stadler22dbfda2011-01-17 12:47:31 -08002638 * @param admin Which {@link DeviceAdminReceiver} this request is associated with. If null,
2639 * this will return the requested encryption setting as an aggregate of all active
2640 * administrators.
2641 * @return true if the admin(s) are requesting encryption, false if not.
Andy Stadler7b0f8f02011-01-12 14:59:52 -08002642 */
Robin Lee25e26452015-06-02 09:56:29 -07002643 public boolean getStorageEncryption(@Nullable ComponentName admin) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01002644 throwIfParentInstance("getStorageEncryption");
Andy Stadler7b0f8f02011-01-12 14:59:52 -08002645 if (mService != null) {
2646 try {
Makoto Onukicc4bbeb2015-09-17 10:28:24 -07002647 return mService.getStorageEncryption(admin, myUserId());
Andy Stadler7b0f8f02011-01-12 14:59:52 -08002648 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07002649 throw e.rethrowFromSystemServer();
Andy Stadler7b0f8f02011-01-12 14:59:52 -08002650 }
2651 }
Andy Stadler22dbfda2011-01-17 12:47:31 -08002652 return false;
2653 }
2654
2655 /**
2656 * Called by an application that is administering the device to
2657 * determine the current encryption status of the device.
Amith Yamasani75db1252016-07-11 14:41:01 -07002658 * <p>
Andy Stadler22dbfda2011-01-17 12:47:31 -08002659 * Depending on the returned status code, the caller may proceed in different
2660 * ways. If the result is {@link #ENCRYPTION_STATUS_UNSUPPORTED}, the
2661 * storage system does not support encryption. If the
2662 * result is {@link #ENCRYPTION_STATUS_INACTIVE}, use {@link
2663 * #ACTION_START_ENCRYPTION} to begin the process of encrypting or decrypting the
Robin Lee3795fb02015-02-16 14:17:23 +00002664 * storage. If the result is {@link #ENCRYPTION_STATUS_ACTIVE_DEFAULT_KEY}, the
2665 * storage system has enabled encryption but no password is set so further action
Amith Yamasani75db1252016-07-11 14:41:01 -07002666 * may be required. If the result is {@link #ENCRYPTION_STATUS_ACTIVATING},
2667 * {@link #ENCRYPTION_STATUS_ACTIVE} or {@link #ENCRYPTION_STATUS_ACTIVE_PER_USER},
2668 * no further action is required.
Andy Stadler22dbfda2011-01-17 12:47:31 -08002669 *
Robin Lee7e678712014-07-24 16:41:31 +01002670 * @return current status of encryption. The value will be one of
Andy Stadler22dbfda2011-01-17 12:47:31 -08002671 * {@link #ENCRYPTION_STATUS_UNSUPPORTED}, {@link #ENCRYPTION_STATUS_INACTIVE},
Robin Lee3795fb02015-02-16 14:17:23 +00002672 * {@link #ENCRYPTION_STATUS_ACTIVATING}, {@link #ENCRYPTION_STATUS_ACTIVE_DEFAULT_KEY},
Amith Yamasani75db1252016-07-11 14:41:01 -07002673 * {@link #ENCRYPTION_STATUS_ACTIVE}, or {@link #ENCRYPTION_STATUS_ACTIVE_PER_USER}.
Andy Stadler22dbfda2011-01-17 12:47:31 -08002674 */
2675 public int getStorageEncryptionStatus() {
Benjamin Franzbc33c822016-04-15 08:57:52 +01002676 throwIfParentInstance("getStorageEncryptionStatus");
Makoto Onukicc4bbeb2015-09-17 10:28:24 -07002677 return getStorageEncryptionStatus(myUserId());
Amith Yamasani599dd7c2012-09-14 23:20:08 -07002678 }
2679
2680 /** @hide per-user version */
2681 public int getStorageEncryptionStatus(int userHandle) {
Andy Stadler22dbfda2011-01-17 12:47:31 -08002682 if (mService != null) {
2683 try {
Makoto Onukid4c9e542016-02-25 18:17:30 -08002684 return mService.getStorageEncryptionStatus(mContext.getPackageName(), userHandle);
Andy Stadler22dbfda2011-01-17 12:47:31 -08002685 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07002686 throw e.rethrowFromSystemServer();
Andy Stadler22dbfda2011-01-17 12:47:31 -08002687 }
2688 }
Andy Stadler7b0f8f02011-01-12 14:59:52 -08002689 return ENCRYPTION_STATUS_UNSUPPORTED;
2690 }
2691
2692 /**
Robin Lee2f7e1e42016-03-21 10:50:01 +00002693 * Mark a CA certificate as approved by the device user. This means that they have been notified
2694 * of the installation, were made aware of the risks, viewed the certificate and still wanted to
2695 * keep the certificate on the device.
2696 *
2697 * Calling with {@param approval} as {@code true} will cancel any ongoing warnings related to
2698 * this certificate.
2699 *
2700 * @hide
2701 */
2702 public boolean approveCaCert(String alias, int userHandle, boolean approval) {
2703 if (mService != null) {
2704 try {
2705 return mService.approveCaCert(alias, userHandle, approval);
2706 } catch (RemoteException e) {
2707 throw e.rethrowFromSystemServer();
2708 }
2709 }
2710 return false;
2711 }
2712
2713 /**
2714 * Check whether a CA certificate has been approved by the device user.
2715 *
2716 * @hide
2717 */
2718 public boolean isCaCertApproved(String alias, int userHandle) {
2719 if (mService != null) {
2720 try {
2721 return mService.isCaCertApproved(alias, userHandle);
2722 } catch (RemoteException e) {
2723 throw e.rethrowFromSystemServer();
2724 }
2725 }
2726 return false;
2727 }
2728
2729 /**
Robin Lee7e678712014-07-24 16:41:31 +01002730 * Installs the given certificate as a user CA.
2731 *
Robin Lee25e26452015-06-02 09:56:29 -07002732 * @param admin Which {@link DeviceAdminReceiver} this request is associated with, or
2733 * {@code null} if calling from a delegated certificate installer.
Robin Lee7e678712014-07-24 16:41:31 +01002734 * @param certBuffer encoded form of the certificate to install.
Maggie Benthallda51e682013-08-08 22:35:44 -04002735 *
2736 * @return false if the certBuffer cannot be parsed or installation is
Robin Lee7e678712014-07-24 16:41:31 +01002737 * interrupted, true otherwise.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07002738 * @throws SecurityException if {@code admin} is not {@code null} and not a device or profile
2739 * owner.
Maggie Benthallda51e682013-08-08 22:35:44 -04002740 */
Robin Lee25e26452015-06-02 09:56:29 -07002741 public boolean installCaCert(@Nullable ComponentName admin, byte[] certBuffer) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01002742 throwIfParentInstance("installCaCert");
Maggie Benthallda51e682013-08-08 22:35:44 -04002743 if (mService != null) {
2744 try {
Robin Lee7e678712014-07-24 16:41:31 +01002745 return mService.installCaCert(admin, certBuffer);
Maggie Benthallda51e682013-08-08 22:35:44 -04002746 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07002747 throw e.rethrowFromSystemServer();
Maggie Benthallda51e682013-08-08 22:35:44 -04002748 }
2749 }
2750 return false;
2751 }
2752
2753 /**
Robin Lee7e678712014-07-24 16:41:31 +01002754 * Uninstalls the given certificate from trusted user CAs, if present.
2755 *
Robin Lee25e26452015-06-02 09:56:29 -07002756 * @param admin Which {@link DeviceAdminReceiver} this request is associated with, or
2757 * {@code null} if calling from a delegated certificate installer.
Robin Lee7e678712014-07-24 16:41:31 +01002758 * @param certBuffer encoded form of the certificate to remove.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07002759 * @throws SecurityException if {@code admin} is not {@code null} and not a device or profile
2760 * owner.
Maggie Benthallda51e682013-08-08 22:35:44 -04002761 */
Robin Lee25e26452015-06-02 09:56:29 -07002762 public void uninstallCaCert(@Nullable ComponentName admin, byte[] certBuffer) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01002763 throwIfParentInstance("uninstallCaCert");
Maggie Benthallda51e682013-08-08 22:35:44 -04002764 if (mService != null) {
2765 try {
Robin Lee306fe082014-06-19 14:04:24 +00002766 final String alias = getCaCertAlias(certBuffer);
Robin Lee83881bd2015-06-09 16:04:38 -07002767 mService.uninstallCaCerts(admin, new String[] {alias});
Robin Lee306fe082014-06-19 14:04:24 +00002768 } catch (CertificateException e) {
2769 Log.w(TAG, "Unable to parse certificate", e);
Maggie Benthallda51e682013-08-08 22:35:44 -04002770 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07002771 throw e.rethrowFromSystemServer();
Maggie Benthallda51e682013-08-08 22:35:44 -04002772 }
2773 }
2774 }
2775
2776 /**
Robin Lee7e678712014-07-24 16:41:31 +01002777 * Returns all CA certificates that are currently trusted, excluding system CA certificates.
2778 * If a user has installed any certificates by other means than device policy these will be
2779 * included too.
2780 *
Robin Lee25e26452015-06-02 09:56:29 -07002781 * @param admin Which {@link DeviceAdminReceiver} this request is associated with, or
2782 * {@code null} if calling from a delegated certificate installer.
Robin Lee7e678712014-07-24 16:41:31 +01002783 * @return a List of byte[] arrays, each encoding one user CA certificate.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07002784 * @throws SecurityException if {@code admin} is not {@code null} and not a device or profile
2785 * owner.
Maggie Benthallda51e682013-08-08 22:35:44 -04002786 */
Robin Lee25e26452015-06-02 09:56:29 -07002787 public List<byte[]> getInstalledCaCerts(@Nullable ComponentName admin) {
Robin Lee7e678712014-07-24 16:41:31 +01002788 List<byte[]> certs = new ArrayList<byte[]>();
Benjamin Franzbc33c822016-04-15 08:57:52 +01002789 throwIfParentInstance("getInstalledCaCerts");
Esteban Talavera808f6ef2014-08-28 17:15:54 +01002790 if (mService != null) {
Robin Lee7e678712014-07-24 16:41:31 +01002791 try {
Esteban Talavera808f6ef2014-08-28 17:15:54 +01002792 mService.enforceCanManageCaCerts(admin);
2793 final TrustedCertificateStore certStore = new TrustedCertificateStore();
2794 for (String alias : certStore.userAliases()) {
2795 try {
2796 certs.add(certStore.getCertificate(alias).getEncoded());
2797 } catch (CertificateException ce) {
2798 Log.w(TAG, "Could not encode certificate: " + alias, ce);
2799 }
2800 }
2801 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07002802 throw re.rethrowFromSystemServer();
Robin Lee7e678712014-07-24 16:41:31 +01002803 }
2804 }
2805 return certs;
Maggie Benthallda51e682013-08-08 22:35:44 -04002806 }
2807
2808 /**
Robin Lee7e678712014-07-24 16:41:31 +01002809 * Uninstalls all custom trusted CA certificates from the profile. Certificates installed by
2810 * means other than device policy will also be removed, except for system CA certificates.
2811 *
Robin Lee25e26452015-06-02 09:56:29 -07002812 * @param admin Which {@link DeviceAdminReceiver} this request is associated with, or
2813 * {@code null} if calling from a delegated certificate installer.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07002814 * @throws SecurityException if {@code admin} is not {@code null} and not a device or profile
2815 * owner.
Robin Lee7e678712014-07-24 16:41:31 +01002816 */
Robin Lee25e26452015-06-02 09:56:29 -07002817 public void uninstallAllUserCaCerts(@Nullable ComponentName admin) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01002818 throwIfParentInstance("uninstallAllUserCaCerts");
Robin Lee7e678712014-07-24 16:41:31 +01002819 if (mService != null) {
Robin Lee83881bd2015-06-09 16:04:38 -07002820 try {
2821 mService.uninstallCaCerts(admin, new TrustedCertificateStore().userAliases()
2822 .toArray(new String[0]));
2823 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07002824 throw re.rethrowFromSystemServer();
Robin Lee7e678712014-07-24 16:41:31 +01002825 }
2826 }
2827 }
2828
2829 /**
2830 * Returns whether this certificate is installed as a trusted CA.
2831 *
Robin Lee25e26452015-06-02 09:56:29 -07002832 * @param admin Which {@link DeviceAdminReceiver} this request is associated with, or
2833 * {@code null} if calling from a delegated certificate installer.
Robin Lee7e678712014-07-24 16:41:31 +01002834 * @param certBuffer encoded form of the certificate to look up.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07002835 * @throws SecurityException if {@code admin} is not {@code null} and not a device or profile
2836 * owner.
Maggie Benthallda51e682013-08-08 22:35:44 -04002837 */
Robin Lee25e26452015-06-02 09:56:29 -07002838 public boolean hasCaCertInstalled(@Nullable ComponentName admin, byte[] certBuffer) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01002839 throwIfParentInstance("hasCaCertInstalled");
Esteban Talavera808f6ef2014-08-28 17:15:54 +01002840 if (mService != null) {
2841 try {
2842 mService.enforceCanManageCaCerts(admin);
2843 return getCaCertAlias(certBuffer) != null;
2844 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07002845 throw re.rethrowFromSystemServer();
Esteban Talavera808f6ef2014-08-28 17:15:54 +01002846 } catch (CertificateException ce) {
2847 Log.w(TAG, "Could not parse certificate", ce);
2848 }
Maggie Benthallda51e682013-08-08 22:35:44 -04002849 }
2850 return false;
2851 }
2852
2853 /**
Robin Leece3399f2016-02-24 12:08:32 +00002854 * Called by a device or profile owner, or delegated certificate installer, to install a
2855 * certificate and corresponding private key. All apps within the profile will be able to access
2856 * the certificate and use the private key, given direct user approval.
2857 *
2858 * <p>Access to the installed credentials will not be granted to the caller of this API without
2859 * direct user approval. This is for security - should a certificate installer become
2860 * compromised, certificates it had already installed will be protected.
2861 *
2862 * <p>If the installer must have access to the credentials, call
Rubin Xub4365912016-03-23 12:13:22 +00002863 * {@link #installKeyPair(ComponentName, PrivateKey, Certificate[], String, boolean)} instead.
Bernhard Bauer26408cc2014-09-08 14:07:31 +01002864 *
Robin Lee25e26452015-06-02 09:56:29 -07002865 * @param admin Which {@link DeviceAdminReceiver} this request is associated with, or
2866 * {@code null} if calling from a delegated certificate installer.
Bernhard Bauer26408cc2014-09-08 14:07:31 +01002867 * @param privKey The private key to install.
2868 * @param cert The certificate to install.
2869 * @param alias The private key alias under which to install the certificate. If a certificate
2870 * with that alias already exists, it will be overwritten.
2871 * @return {@code true} if the keys were installed, {@code false} otherwise.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07002872 * @throws SecurityException if {@code admin} is not {@code null} and not a device or profile
2873 * owner.
Bernhard Bauer26408cc2014-09-08 14:07:31 +01002874 */
Robin Leefbc65642015-08-03 16:21:22 +01002875 public boolean installKeyPair(@Nullable ComponentName admin, @NonNull PrivateKey privKey,
2876 @NonNull Certificate cert, @NonNull String alias) {
Rubin Xub4365912016-03-23 12:13:22 +00002877 return installKeyPair(admin, privKey, new Certificate[] {cert}, alias, false);
Robin Leece3399f2016-02-24 12:08:32 +00002878 }
2879
2880 /**
2881 * Called by a device or profile owner, or delegated certificate installer, to install a
Rubin Xub4365912016-03-23 12:13:22 +00002882 * certificate chain and corresponding private key for the leaf certificate. All apps within the
2883 * profile will be able to access the certificate chain and use the private key, given direct
2884 * user approval.
Robin Leece3399f2016-02-24 12:08:32 +00002885 *
Robin Leea1b290e2016-03-09 14:38:36 +00002886 * <p>The caller of this API may grant itself access to the certificate and private key
2887 * immediately, without user approval. It is a best practice not to request this unless strictly
2888 * necessary since it opens up additional security vulnerabilities.
Robin Leece3399f2016-02-24 12:08:32 +00002889 *
2890 * @param admin Which {@link DeviceAdminReceiver} this request is associated with, or
Robin Leea1b290e2016-03-09 14:38:36 +00002891 * {@code null} if calling from a delegated certificate installer.
Robin Leece3399f2016-02-24 12:08:32 +00002892 * @param privKey The private key to install.
Rubin Xub4365912016-03-23 12:13:22 +00002893 * @param certs The certificate chain to install. The chain should start with the leaf
2894 * certificate and include the chain of trust in order. This will be returned by
2895 * {@link android.security.KeyChain#getCertificateChain}.
Robin Leece3399f2016-02-24 12:08:32 +00002896 * @param alias The private key alias under which to install the certificate. If a certificate
Robin Leea1b290e2016-03-09 14:38:36 +00002897 * with that alias already exists, it will be overwritten.
Robin Leece3399f2016-02-24 12:08:32 +00002898 * @param requestAccess {@code true} to request that the calling app be granted access to the
Robin Leea1b290e2016-03-09 14:38:36 +00002899 * credentials immediately. Otherwise, access to the credentials will be gated by user
2900 * approval.
Robin Leece3399f2016-02-24 12:08:32 +00002901 * @return {@code true} if the keys were installed, {@code false} otherwise.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07002902 * @throws SecurityException if {@code admin} is not {@code null} and not a device or profile
2903 * owner.
Rubin Xub4365912016-03-23 12:13:22 +00002904 * @see android.security.KeyChain#getCertificateChain
Robin Leece3399f2016-02-24 12:08:32 +00002905 */
2906 public boolean installKeyPair(@Nullable ComponentName admin, @NonNull PrivateKey privKey,
Rubin Xub4365912016-03-23 12:13:22 +00002907 @NonNull Certificate[] certs, @NonNull String alias, boolean requestAccess) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01002908 throwIfParentInstance("installKeyPair");
Bernhard Bauer26408cc2014-09-08 14:07:31 +01002909 try {
Rubin Xub4365912016-03-23 12:13:22 +00002910 final byte[] pemCert = Credentials.convertToPem(certs[0]);
2911 byte[] pemChain = null;
2912 if (certs.length > 1) {
2913 pemChain = Credentials.convertToPem(Arrays.copyOfRange(certs, 1, certs.length));
2914 }
Robin Lee0d5ccb72014-09-12 17:41:44 +01002915 final byte[] pkcs8Key = KeyFactory.getInstance(privKey.getAlgorithm())
2916 .getKeySpec(privKey, PKCS8EncodedKeySpec.class).getEncoded();
Rubin Xub4365912016-03-23 12:13:22 +00002917 return mService.installKeyPair(admin, pkcs8Key, pemCert, pemChain, alias,
2918 requestAccess);
Bernhard Bauer26408cc2014-09-08 14:07:31 +01002919 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07002920 throw e.rethrowFromSystemServer();
Robin Lee0d5ccb72014-09-12 17:41:44 +01002921 } catch (NoSuchAlgorithmException | InvalidKeySpecException e) {
2922 Log.w(TAG, "Failed to obtain private key material", e);
2923 } catch (CertificateException | IOException e) {
2924 Log.w(TAG, "Could not pem-encode certificate", e);
Bernhard Bauer26408cc2014-09-08 14:07:31 +01002925 }
2926 return false;
2927 }
2928
2929 /**
Robin Leea1b290e2016-03-09 14:38:36 +00002930 * Called by a device or profile owner, or delegated certificate installer, to remove a
2931 * certificate and private key pair installed under a given alias.
Robin Leefbc65642015-08-03 16:21:22 +01002932 *
2933 * @param admin Which {@link DeviceAdminReceiver} this request is associated with, or
Robin Leea1b290e2016-03-09 14:38:36 +00002934 * {@code null} if calling from a delegated certificate installer.
Robin Leefbc65642015-08-03 16:21:22 +01002935 * @param alias The private key alias under which the certificate is installed.
Robin Leea1b290e2016-03-09 14:38:36 +00002936 * @return {@code true} if the private key alias no longer exists, {@code false} otherwise.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07002937 * @throws SecurityException if {@code admin} is not {@code null} and not a device or profile
2938 * owner.
Robin Leefbc65642015-08-03 16:21:22 +01002939 */
2940 public boolean removeKeyPair(@Nullable ComponentName admin, @NonNull String alias) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01002941 throwIfParentInstance("removeKeyPair");
Robin Leefbc65642015-08-03 16:21:22 +01002942 try {
2943 return mService.removeKeyPair(admin, alias);
2944 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07002945 throw e.rethrowFromSystemServer();
Robin Leefbc65642015-08-03 16:21:22 +01002946 }
Robin Leefbc65642015-08-03 16:21:22 +01002947 }
2948
2949 /**
Robin Lee25e26452015-06-02 09:56:29 -07002950 * @return the alias of a given CA certificate in the certificate store, or {@code null} if it
Robin Lee306fe082014-06-19 14:04:24 +00002951 * doesn't exist.
2952 */
2953 private static String getCaCertAlias(byte[] certBuffer) throws CertificateException {
2954 final CertificateFactory certFactory = CertificateFactory.getInstance("X.509");
2955 final X509Certificate cert = (X509Certificate) certFactory.generateCertificate(
2956 new ByteArrayInputStream(certBuffer));
2957 return new TrustedCertificateStore().getCertificateAlias(cert);
2958 }
2959
2960 /**
Rubin Xuec32b562015-03-03 17:34:05 +00002961 * Called by a profile owner or device owner to grant access to privileged certificate
Rubin Xuacdc1832015-04-02 12:40:20 +01002962 * manipulation APIs to a third-party certificate installer app. Granted APIs include
Rubin Xuec32b562015-03-03 17:34:05 +00002963 * {@link #getInstalledCaCerts}, {@link #hasCaCertInstalled}, {@link #installCaCert},
Rubin Xuacdc1832015-04-02 12:40:20 +01002964 * {@link #uninstallCaCert}, {@link #uninstallAllUserCaCerts} and {@link #installKeyPair}.
Rubin Xuec32b562015-03-03 17:34:05 +00002965 * <p>
2966 * Delegated certificate installer is a per-user state. The delegated access is persistent until
2967 * it is later cleared by calling this method with a null value or uninstallling the certificate
2968 * installer.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07002969 * <p>
Rubin Xuf03d0a62016-02-10 14:54:15 +00002970 * <b>Note:</b>Starting from {@link android.os.Build.VERSION_CODES#N}, if the caller
2971 * application's target SDK version is {@link android.os.Build.VERSION_CODES#N} or newer, the
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07002972 * supplied certificate installer package must be installed when calling this API, otherwise an
2973 * {@link IllegalArgumentException} will be thrown.
Rubin Xuec32b562015-03-03 17:34:05 +00002974 *
Robin Lee25e26452015-06-02 09:56:29 -07002975 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
Rubin Xuec32b562015-03-03 17:34:05 +00002976 * @param installerPackage The package name of the certificate installer which will be given
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07002977 * access. If {@code null} is given the current package will be cleared.
2978 * @throws SecurityException if {@code admin} is not a device or a profile owner.
Rubin Xuec32b562015-03-03 17:34:05 +00002979 */
Robin Lee25e26452015-06-02 09:56:29 -07002980 public void setCertInstallerPackage(@NonNull ComponentName admin, @Nullable String
2981 installerPackage) throws SecurityException {
Benjamin Franzbc33c822016-04-15 08:57:52 +01002982 throwIfParentInstance("setCertInstallerPackage");
Rubin Xuec32b562015-03-03 17:34:05 +00002983 if (mService != null) {
2984 try {
Robin Lee25e26452015-06-02 09:56:29 -07002985 mService.setCertInstallerPackage(admin, installerPackage);
Rubin Xuec32b562015-03-03 17:34:05 +00002986 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07002987 throw e.rethrowFromSystemServer();
Rubin Xuec32b562015-03-03 17:34:05 +00002988 }
2989 }
2990 }
2991
2992 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07002993 * Called by a profile owner or device owner to retrieve the certificate installer for the user.
2994 * null if none is set.
Rubin Xuec32b562015-03-03 17:34:05 +00002995 *
Robin Lee25e26452015-06-02 09:56:29 -07002996 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07002997 * @return The package name of the current delegated certificate installer, or {@code null} if
2998 * none is set.
2999 * @throws SecurityException if {@code admin} is not a device or a profile owner.
Rubin Xuec32b562015-03-03 17:34:05 +00003000 */
Robin Lee25e26452015-06-02 09:56:29 -07003001 public String getCertInstallerPackage(@NonNull ComponentName admin) throws SecurityException {
Benjamin Franzbc33c822016-04-15 08:57:52 +01003002 throwIfParentInstance("getCertInstallerPackage");
Rubin Xuec32b562015-03-03 17:34:05 +00003003 if (mService != null) {
3004 try {
Robin Lee25e26452015-06-02 09:56:29 -07003005 return mService.getCertInstallerPackage(admin);
Rubin Xuec32b562015-03-03 17:34:05 +00003006 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07003007 throw e.rethrowFromSystemServer();
Rubin Xuec32b562015-03-03 17:34:05 +00003008 }
3009 }
3010 return null;
3011 }
3012
3013 /**
Robin Lee244ce8e2016-01-05 18:03:46 +00003014 * Called by a device or profile owner to configure an always-on VPN connection through a
Robin Leedc679712016-05-03 13:23:03 +01003015 * specific application for the current user.
3016 *
3017 * @deprecated this version only exists for compability with previous developer preview builds.
3018 * TODO: delete once there are no longer any live references.
3019 * @hide
3020 */
3021 public void setAlwaysOnVpnPackage(@NonNull ComponentName admin, @Nullable String vpnPackage)
3022 throws NameNotFoundException, UnsupportedOperationException {
3023 setAlwaysOnVpnPackage(admin, vpnPackage, /* lockdownEnabled */ true);
3024 }
3025
3026 /**
3027 * Called by a device or profile owner to configure an always-on VPN connection through a
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07003028 * specific application for the current user. This connection is automatically granted and
3029 * persisted after a reboot.
3030 * <p>
3031 * The designated package should declare a {@link android.net.VpnService} in its manifest
3032 * guarded by {@link android.Manifest.permission#BIND_VPN_SERVICE}, otherwise the call will
3033 * fail.
Robin Lee244ce8e2016-01-05 18:03:46 +00003034 *
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07003035 * @param vpnPackage The package name for an installed VPN app on the device, or {@code null} to
Robin Leedc679712016-05-03 13:23:03 +01003036 * remove an existing always-on VPN configuration.
3037 * @param lockdownEnabled {@code true} to disallow networking when the VPN is not connected or
3038 * {@code false} otherwise. This carries the risk that any failure of the VPN provider
3039 * could break networking for all apps. This has no effect when clearing.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07003040 * @throws SecurityException if {@code admin} is not a device or a profile owner.
Robin Leeee5eb932016-04-05 16:27:15 +01003041 * @throws NameNotFoundException if {@code vpnPackage} is not installed.
3042 * @throws UnsupportedOperationException if {@code vpnPackage} exists but does not support being
3043 * set as always-on, or if always-on VPN is not available.
Robin Lee244ce8e2016-01-05 18:03:46 +00003044 */
Robin Leedc679712016-05-03 13:23:03 +01003045 public void setAlwaysOnVpnPackage(@NonNull ComponentName admin, @Nullable String vpnPackage,
3046 boolean lockdownEnabled)
Robin Leeee5eb932016-04-05 16:27:15 +01003047 throws NameNotFoundException, UnsupportedOperationException {
Benjamin Franzbc33c822016-04-15 08:57:52 +01003048 throwIfParentInstance("setAlwaysOnVpnPackage");
Robin Lee244ce8e2016-01-05 18:03:46 +00003049 if (mService != null) {
3050 try {
Robin Leedc679712016-05-03 13:23:03 +01003051 if (!mService.setAlwaysOnVpnPackage(admin, vpnPackage, lockdownEnabled)) {
Robin Leeee5eb932016-04-05 16:27:15 +01003052 throw new NameNotFoundException(vpnPackage);
3053 }
Robin Lee244ce8e2016-01-05 18:03:46 +00003054 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07003055 throw e.rethrowFromSystemServer();
Robin Lee244ce8e2016-01-05 18:03:46 +00003056 }
3057 }
Robin Lee244ce8e2016-01-05 18:03:46 +00003058 }
3059
3060 /**
3061 * Called by a device or profile owner to read the name of the package administering an
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07003062 * always-on VPN connection for the current user. If there is no such package, or the always-on
3063 * VPN is provided by the system instead of by an application, {@code null} will be returned.
Robin Lee244ce8e2016-01-05 18:03:46 +00003064 *
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07003065 * @return Package name of VPN controller responsible for always-on VPN, or {@code null} if none
3066 * is set.
3067 * @throws SecurityException if {@code admin} is not a device or a profile owner.
Robin Lee244ce8e2016-01-05 18:03:46 +00003068 */
3069 public String getAlwaysOnVpnPackage(@NonNull ComponentName admin) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01003070 throwIfParentInstance("getAlwaysOnVpnPackage");
Robin Lee244ce8e2016-01-05 18:03:46 +00003071 if (mService != null) {
3072 try {
3073 return mService.getAlwaysOnVpnPackage(admin);
3074 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07003075 throw e.rethrowFromSystemServer();
Robin Lee244ce8e2016-01-05 18:03:46 +00003076 }
3077 }
3078 return null;
3079 }
3080
3081 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07003082 * Called by an application that is administering the device to disable all cameras on the
3083 * device, for this user. After setting this, no applications running as this user will be able
3084 * to access any cameras on the device.
3085 * <p>
3086 * If the caller is device owner, then the restriction will be applied to all users.
3087 * <p>
3088 * The calling device admin must have requested
3089 * {@link DeviceAdminInfo#USES_POLICY_DISABLE_CAMERA} to be able to call this method; if it has
3090 * not, a security exception will be thrown.
Ben Komalo2447edd2011-05-09 16:05:33 -07003091 *
3092 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
3093 * @param disabled Whether or not the camera should be disabled.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07003094 * @throws SecurityException if {@code admin} is not an active administrator or does not use
3095 * {@link DeviceAdminInfo#USES_POLICY_DISABLE_CAMERA}.
Ben Komalo2447edd2011-05-09 16:05:33 -07003096 */
Robin Lee25e26452015-06-02 09:56:29 -07003097 public void setCameraDisabled(@NonNull ComponentName admin, boolean disabled) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01003098 throwIfParentInstance("setCameraDisabled");
Ben Komalo2447edd2011-05-09 16:05:33 -07003099 if (mService != null) {
3100 try {
Fyodor Kupolovbdc58c62015-01-29 13:24:03 -08003101 mService.setCameraDisabled(admin, disabled);
Ben Komalo2447edd2011-05-09 16:05:33 -07003102 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07003103 throw e.rethrowFromSystemServer();
Ben Komalo2447edd2011-05-09 16:05:33 -07003104 }
3105 }
3106 }
3107
3108 /**
Amith Yamasani242f4b12014-10-14 16:06:13 -07003109 * Determine whether or not the device's cameras have been disabled for this user,
Makoto Onuki32b30572015-12-11 14:29:51 -08003110 * either by the calling admin, if specified, or all admins.
Robin Lee25e26452015-06-02 09:56:29 -07003111 * @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 -07003112 * have disabled the camera
3113 */
Robin Lee25e26452015-06-02 09:56:29 -07003114 public boolean getCameraDisabled(@Nullable ComponentName admin) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01003115 throwIfParentInstance("getCameraDisabled");
Makoto Onukicc4bbeb2015-09-17 10:28:24 -07003116 return getCameraDisabled(admin, myUserId());
Amith Yamasani599dd7c2012-09-14 23:20:08 -07003117 }
3118
3119 /** @hide per-user version */
Robin Lee25e26452015-06-02 09:56:29 -07003120 public boolean getCameraDisabled(@Nullable ComponentName admin, int userHandle) {
Ben Komalo2447edd2011-05-09 16:05:33 -07003121 if (mService != null) {
3122 try {
Amith Yamasani599dd7c2012-09-14 23:20:08 -07003123 return mService.getCameraDisabled(admin, userHandle);
Ben Komalo2447edd2011-05-09 16:05:33 -07003124 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07003125 throw e.rethrowFromSystemServer();
Ben Komalo2447edd2011-05-09 16:05:33 -07003126 }
3127 }
3128 return false;
3129 }
3130
3131 /**
Michal Karpinski3fc437e2015-12-15 10:09:00 +00003132 * Called by a device owner to request a bugreport.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07003133 * <p>
3134 * There must be only one user on the device, managed by the device owner. Otherwise a
3135 * {@link SecurityException} will be thrown.
Michal Karpinski3fc437e2015-12-15 10:09:00 +00003136 *
3137 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07003138 * @return {@code true} if the bugreport collection started successfully, or {@code false} if it
3139 * wasn't triggered because a previous bugreport operation is still active (either the
3140 * bugreport is still running or waiting for the user to share or decline)
3141 * @throws SecurityException if {@code admin} is not a device owner, or if there are users other
3142 * than the one managed by the device owner.
Michal Karpinski3fc437e2015-12-15 10:09:00 +00003143 */
3144 public boolean requestBugreport(@NonNull ComponentName admin) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01003145 throwIfParentInstance("requestBugreport");
Michal Karpinski3fc437e2015-12-15 10:09:00 +00003146 if (mService != null) {
3147 try {
3148 return mService.requestBugreport(admin);
3149 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07003150 throw e.rethrowFromSystemServer();
Michal Karpinski3fc437e2015-12-15 10:09:00 +00003151 }
3152 }
3153 return false;
3154 }
3155
3156 /**
Fyodor Kupolovcd86ebf2015-09-29 17:06:50 -07003157 * Determine whether or not creating a guest user has been disabled for the device
3158 *
3159 * @hide
3160 */
3161 public boolean getGuestUserDisabled(@Nullable ComponentName admin) {
3162 // Currently guest users can always be created if multi-user is enabled
3163 // TODO introduce a policy for guest user creation
3164 return false;
3165 }
3166
3167 /**
Esteban Talavera1aee98f2014-08-21 14:03:55 +01003168 * Called by a device/profile owner to set whether the screen capture is disabled. Disabling
3169 * screen capture also prevents the content from being shown on display devices that do not have
3170 * a secure video output. See {@link android.view.Display#FLAG_SECURE} for more details about
3171 * secure surfaces and secure displays.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07003172 * <p>
3173 * The calling device admin must be a device or profile owner. If it is not, a security
3174 * exception will be thrown.
3175 * <p>
3176 * From version {@link android.os.Build.VERSION_CODES#M} disabling screen capture also blocks
3177 * assist requests for all activities of the relevant user.
Benjamin Franzc200f442015-06-25 18:20:04 +01003178 *
Sander Alewijnsed2a1eec2014-07-09 12:57:05 +01003179 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
Sander Alewijnse0ced6272014-08-26 11:18:26 +01003180 * @param disabled Whether screen capture is disabled or not.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07003181 * @throws SecurityException if {@code admin} is not a device or profile owner.
Sander Alewijnsed2a1eec2014-07-09 12:57:05 +01003182 */
Robin Lee25e26452015-06-02 09:56:29 -07003183 public void setScreenCaptureDisabled(@NonNull ComponentName admin, boolean disabled) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01003184 throwIfParentInstance("setScreenCaptureDisabled");
Sander Alewijnsed2a1eec2014-07-09 12:57:05 +01003185 if (mService != null) {
3186 try {
Fyodor Kupolovbdc58c62015-01-29 13:24:03 -08003187 mService.setScreenCaptureDisabled(admin, disabled);
Sander Alewijnsed2a1eec2014-07-09 12:57:05 +01003188 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07003189 throw e.rethrowFromSystemServer();
Sander Alewijnsed2a1eec2014-07-09 12:57:05 +01003190 }
3191 }
3192 }
3193
3194 /**
Makoto Onuki32b30572015-12-11 14:29:51 -08003195 * Determine whether or not screen capture has been disabled by the calling
Sander Alewijnsed2a1eec2014-07-09 12:57:05 +01003196 * admin, if specified, or all admins.
Robin Lee25e26452015-06-02 09:56:29 -07003197 * @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 +01003198 * have disabled screen capture.
3199 */
Robin Lee25e26452015-06-02 09:56:29 -07003200 public boolean getScreenCaptureDisabled(@Nullable ComponentName admin) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01003201 throwIfParentInstance("getScreenCaptureDisabled");
Makoto Onukicc4bbeb2015-09-17 10:28:24 -07003202 return getScreenCaptureDisabled(admin, myUserId());
Sander Alewijnsed2a1eec2014-07-09 12:57:05 +01003203 }
3204
3205 /** @hide per-user version */
Robin Lee25e26452015-06-02 09:56:29 -07003206 public boolean getScreenCaptureDisabled(@Nullable ComponentName admin, int userHandle) {
Sander Alewijnsed2a1eec2014-07-09 12:57:05 +01003207 if (mService != null) {
3208 try {
3209 return mService.getScreenCaptureDisabled(admin, userHandle);
3210 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07003211 throw e.rethrowFromSystemServer();
Sander Alewijnsed2a1eec2014-07-09 12:57:05 +01003212 }
3213 }
3214 return false;
3215 }
3216
3217 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07003218 * Called by a device owner to set whether auto time is required. If auto time is required the
3219 * user cannot set the date and time, but has to use network date and time.
3220 * <p>
3221 * Note: if auto time is required the user can still manually set the time zone.
3222 * <p>
3223 * The calling device admin must be a device owner. If it is not, a security exception will be
3224 * thrown.
Sander Alewijnse0ced6272014-08-26 11:18:26 +01003225 *
3226 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
3227 * @param required Whether auto time is set required or not.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07003228 * @throws SecurityException if {@code admin} is not a device owner.
Sander Alewijnse0ced6272014-08-26 11:18:26 +01003229 */
Robin Lee25e26452015-06-02 09:56:29 -07003230 public void setAutoTimeRequired(@NonNull ComponentName admin, boolean required) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01003231 throwIfParentInstance("setAutoTimeRequired");
Sander Alewijnse0ced6272014-08-26 11:18:26 +01003232 if (mService != null) {
3233 try {
Fyodor Kupolovbdc58c62015-01-29 13:24:03 -08003234 mService.setAutoTimeRequired(admin, required);
Sander Alewijnse0ced6272014-08-26 11:18:26 +01003235 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07003236 throw e.rethrowFromSystemServer();
Sander Alewijnse0ced6272014-08-26 11:18:26 +01003237 }
3238 }
3239 }
3240
3241 /**
3242 * @return true if auto time is required.
3243 */
3244 public boolean getAutoTimeRequired() {
Benjamin Franzbc33c822016-04-15 08:57:52 +01003245 throwIfParentInstance("getAutoTimeRequired");
Sander Alewijnse0ced6272014-08-26 11:18:26 +01003246 if (mService != null) {
3247 try {
3248 return mService.getAutoTimeRequired();
3249 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07003250 throw e.rethrowFromSystemServer();
Sander Alewijnse0ced6272014-08-26 11:18:26 +01003251 }
3252 }
3253 return false;
3254 }
3255
3256 /**
Lenka Trochtovaf348e8e2016-01-07 17:20:34 +01003257 * Called by a device owner to set whether all users created on the device should be ephemeral.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07003258 * <p>
3259 * The system user is exempt from this policy - it is never ephemeral.
3260 * <p>
3261 * The calling device admin must be the device owner. If it is not, a security exception will be
3262 * thrown.
Lenka Trochtovaf348e8e2016-01-07 17:20:34 +01003263 *
3264 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
3265 * @param forceEphemeralUsers If true, all the existing users will be deleted and all
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07003266 * subsequently created users will be ephemeral.
3267 * @throws SecurityException if {@code admin} is not a device owner.
Lenka Trochtovaf348e8e2016-01-07 17:20:34 +01003268 * @hide
3269 */
3270 public void setForceEphemeralUsers(
3271 @NonNull ComponentName admin, boolean forceEphemeralUsers) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01003272 throwIfParentInstance("setForceEphemeralUsers");
Lenka Trochtovaf348e8e2016-01-07 17:20:34 +01003273 if (mService != null) {
3274 try {
3275 mService.setForceEphemeralUsers(admin, forceEphemeralUsers);
3276 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07003277 throw e.rethrowFromSystemServer();
Lenka Trochtovaf348e8e2016-01-07 17:20:34 +01003278 }
3279 }
3280 }
3281
3282 /**
3283 * @return true if all users are created ephemeral.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07003284 * @throws SecurityException if {@code admin} is not a device owner.
Lenka Trochtovaf348e8e2016-01-07 17:20:34 +01003285 * @hide
3286 */
3287 public boolean getForceEphemeralUsers(@NonNull ComponentName admin) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01003288 throwIfParentInstance("getForceEphemeralUsers");
Lenka Trochtovaf348e8e2016-01-07 17:20:34 +01003289 if (mService != null) {
3290 try {
3291 return mService.getForceEphemeralUsers(admin);
3292 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07003293 throw e.rethrowFromSystemServer();
Lenka Trochtovaf348e8e2016-01-07 17:20:34 +01003294 }
3295 }
3296 return false;
3297 }
3298
3299 /**
Jim Miller48b9b0d2012-09-19 23:16:50 -07003300 * Called by an application that is administering the device to disable keyguard customizations,
3301 * such as widgets. After setting this, keyguard features will be disabled according to the
3302 * provided feature list.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07003303 * <p>
3304 * The calling device admin must have requested
3305 * {@link DeviceAdminInfo#USES_POLICY_DISABLE_KEYGUARD_FEATURES} to be able to call this method;
3306 * if it has not, a security exception will be thrown.
3307 * <p>
3308 * Calling this from a managed profile before version {@link android.os.Build.VERSION_CODES#M}
3309 * will throw a security exception. From version {@link android.os.Build.VERSION_CODES#M} the
3310 * profile owner of a managed profile can set:
Kenny Guy0b7dd1e2015-03-12 17:14:38 +00003311 * <ul>
Esteban Talaverac1c83592016-02-17 17:56:15 +00003312 * <li>{@link #KEYGUARD_DISABLE_TRUST_AGENTS}, which affects the parent user, but only if there
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07003313 * is no separate challenge set on the managed profile.
Esteban Talaverac1c83592016-02-17 17:56:15 +00003314 * <li>{@link #KEYGUARD_DISABLE_FINGERPRINT} which affects the managed profile challenge if
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07003315 * there is one, or the parent user otherwise.
3316 * <li>{@link #KEYGUARD_DISABLE_UNREDACTED_NOTIFICATIONS} which affects notifications generated
3317 * by applications in the managed profile.
Kenny Guy0b7dd1e2015-03-12 17:14:38 +00003318 * </ul>
Esteban Talaverac1c83592016-02-17 17:56:15 +00003319 * {@link #KEYGUARD_DISABLE_TRUST_AGENTS} and {@link #KEYGUARD_DISABLE_FINGERPRINT} can also be
3320 * set on the {@link DevicePolicyManager} instance returned by
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07003321 * {@link #getParentProfileInstance(ComponentName)} in order to set restrictions on the parent
3322 * profile.
3323 * <p>
3324 * Requests to disable other features on a managed profile will be ignored.
3325 * <p>
3326 * The admin can check which features have been disabled by calling
Kenny Guy0b7dd1e2015-03-12 17:14:38 +00003327 * {@link #getKeyguardDisabledFeatures(ComponentName)}
Amith Yamasani242f4b12014-10-14 16:06:13 -07003328 *
Jim Millerb8ec4702012-08-31 17:19:10 -07003329 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
Jim Miller35207742012-11-02 15:33:20 -07003330 * @param which {@link #KEYGUARD_DISABLE_FEATURES_NONE} (default),
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07003331 * {@link #KEYGUARD_DISABLE_WIDGETS_ALL}, {@link #KEYGUARD_DISABLE_SECURE_CAMERA},
3332 * {@link #KEYGUARD_DISABLE_SECURE_NOTIFICATIONS},
3333 * {@link #KEYGUARD_DISABLE_TRUST_AGENTS},
3334 * {@link #KEYGUARD_DISABLE_UNREDACTED_NOTIFICATIONS},
3335 * {@link #KEYGUARD_DISABLE_FINGERPRINT}, {@link #KEYGUARD_DISABLE_FEATURES_ALL}
3336 * @throws SecurityException if {@code admin} is not an active administrator or does not user
3337 * {@link DeviceAdminInfo#USES_POLICY_DISABLE_KEYGUARD_FEATURES}
Jim Millerb8ec4702012-08-31 17:19:10 -07003338 */
Robin Lee25e26452015-06-02 09:56:29 -07003339 public void setKeyguardDisabledFeatures(@NonNull ComponentName admin, int which) {
Jim Millerb8ec4702012-08-31 17:19:10 -07003340 if (mService != null) {
3341 try {
Esteban Talavera62399912016-01-11 15:37:55 +00003342 mService.setKeyguardDisabledFeatures(admin, which, mParentInstance);
Jim Millerb8ec4702012-08-31 17:19:10 -07003343 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07003344 throw e.rethrowFromSystemServer();
Jim Millerb8ec4702012-08-31 17:19:10 -07003345 }
3346 }
3347 }
3348
3349 /**
Makoto Onuki32b30572015-12-11 14:29:51 -08003350 * Determine whether or not features have been disabled in keyguard either by the calling
Rubin Xud3609d42016-07-13 18:32:57 +01003351 * admin, if specified, or all admins that set restrictions on this user and its participating
Esteban Talaverac1c83592016-02-17 17:56:15 +00003352 * profiles. Restrictions on profiles that have a separate challenge are not taken into account.
3353 *
3354 * <p>This method can be called on the {@link DevicePolicyManager} instance
3355 * returned by {@link #getParentProfileInstance(ComponentName)} in order to retrieve
3356 * restrictions on the parent profile.
3357 *
Esteban Talavera62399912016-01-11 15:37:55 +00003358 * @param admin The name of the admin component to check, or {@code null} to check whether any
3359 * admins have disabled features in keyguard.
Jim Miller35207742012-11-02 15:33:20 -07003360 * @return bitfield of flags. See {@link #setKeyguardDisabledFeatures(ComponentName, int)}
3361 * for a list.
Jim Millerb8ec4702012-08-31 17:19:10 -07003362 */
Robin Lee25e26452015-06-02 09:56:29 -07003363 public int getKeyguardDisabledFeatures(@Nullable ComponentName admin) {
Makoto Onukicc4bbeb2015-09-17 10:28:24 -07003364 return getKeyguardDisabledFeatures(admin, myUserId());
Amith Yamasani599dd7c2012-09-14 23:20:08 -07003365 }
3366
3367 /** @hide per-user version */
Robin Lee25e26452015-06-02 09:56:29 -07003368 public int getKeyguardDisabledFeatures(@Nullable ComponentName admin, int userHandle) {
Jim Millerb8ec4702012-08-31 17:19:10 -07003369 if (mService != null) {
3370 try {
Esteban Talavera62399912016-01-11 15:37:55 +00003371 return mService.getKeyguardDisabledFeatures(admin, userHandle, mParentInstance);
Jim Millerb8ec4702012-08-31 17:19:10 -07003372 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07003373 throw e.rethrowFromSystemServer();
Jim Millerb8ec4702012-08-31 17:19:10 -07003374 }
3375 }
Jim Miller48b9b0d2012-09-19 23:16:50 -07003376 return KEYGUARD_DISABLE_FEATURES_NONE;
Jim Millerb8ec4702012-08-31 17:19:10 -07003377 }
3378
3379 /**
Dianne Hackbornd6847842010-01-12 18:14:19 -08003380 * @hide
3381 */
Robin Lee25e26452015-06-02 09:56:29 -07003382 public void setActiveAdmin(@NonNull ComponentName policyReceiver, boolean refreshing,
3383 int userHandle) {
Dianne Hackbornd6847842010-01-12 18:14:19 -08003384 if (mService != null) {
3385 try {
Jessica Hummel6d36b602014-04-04 12:42:17 +01003386 mService.setActiveAdmin(policyReceiver, refreshing, userHandle);
Dianne Hackbornd6847842010-01-12 18:14:19 -08003387 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07003388 throw e.rethrowFromSystemServer();
Dianne Hackbornd6847842010-01-12 18:14:19 -08003389 }
3390 }
3391 }
Konstantin Lopyrev32558232010-05-20 16:18:05 -07003392
Dianne Hackbornd6847842010-01-12 18:14:19 -08003393 /**
Jessica Hummel6d36b602014-04-04 12:42:17 +01003394 * @hide
3395 */
Robin Lee25e26452015-06-02 09:56:29 -07003396 public void setActiveAdmin(@NonNull ComponentName policyReceiver, boolean refreshing) {
Makoto Onukicc4bbeb2015-09-17 10:28:24 -07003397 setActiveAdmin(policyReceiver, refreshing, myUserId());
Jessica Hummel6d36b602014-04-04 12:42:17 +01003398 }
3399
3400 /**
Dianne Hackbornd6847842010-01-12 18:14:19 -08003401 * @hide
3402 */
Robin Lee25e26452015-06-02 09:56:29 -07003403 public void getRemoveWarning(@Nullable ComponentName admin, RemoteCallback result) {
Dianne Hackborn8ea138c2010-01-26 18:01:04 -08003404 if (mService != null) {
3405 try {
Makoto Onukicc4bbeb2015-09-17 10:28:24 -07003406 mService.getRemoveWarning(admin, result, myUserId());
Dianne Hackborn8ea138c2010-01-26 18:01:04 -08003407 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07003408 throw e.rethrowFromSystemServer();
Dianne Hackborn8ea138c2010-01-26 18:01:04 -08003409 }
3410 }
3411 }
3412
3413 /**
3414 * @hide
3415 */
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07003416 public void setActivePasswordState(int quality, int length, int letters, int uppercase,
Amith Yamasani599dd7c2012-09-14 23:20:08 -07003417 int lowercase, int numbers, int symbols, int nonletter, int userHandle) {
Dianne Hackbornd6847842010-01-12 18:14:19 -08003418 if (mService != null) {
3419 try {
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07003420 mService.setActivePasswordState(quality, length, letters, uppercase, lowercase,
Amith Yamasani599dd7c2012-09-14 23:20:08 -07003421 numbers, symbols, nonletter, userHandle);
Dianne Hackbornd6847842010-01-12 18:14:19 -08003422 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07003423 throw e.rethrowFromSystemServer();
Dianne Hackbornd6847842010-01-12 18:14:19 -08003424 }
3425 }
3426 }
Konstantin Lopyrev32558232010-05-20 16:18:05 -07003427
Dianne Hackbornd6847842010-01-12 18:14:19 -08003428 /**
3429 * @hide
3430 */
Amith Yamasani599dd7c2012-09-14 23:20:08 -07003431 public void reportFailedPasswordAttempt(int userHandle) {
Dianne Hackbornd6847842010-01-12 18:14:19 -08003432 if (mService != null) {
3433 try {
Amith Yamasani599dd7c2012-09-14 23:20:08 -07003434 mService.reportFailedPasswordAttempt(userHandle);
Dianne Hackbornd6847842010-01-12 18:14:19 -08003435 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07003436 throw e.rethrowFromSystemServer();
Dianne Hackbornd6847842010-01-12 18:14:19 -08003437 }
3438 }
3439 }
Konstantin Lopyrev32558232010-05-20 16:18:05 -07003440
Dianne Hackbornd6847842010-01-12 18:14:19 -08003441 /**
3442 * @hide
3443 */
Amith Yamasani599dd7c2012-09-14 23:20:08 -07003444 public void reportSuccessfulPasswordAttempt(int userHandle) {
Dianne Hackbornd6847842010-01-12 18:14:19 -08003445 if (mService != null) {
3446 try {
Amith Yamasani599dd7c2012-09-14 23:20:08 -07003447 mService.reportSuccessfulPasswordAttempt(userHandle);
Dianne Hackbornd6847842010-01-12 18:14:19 -08003448 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07003449 throw e.rethrowFromSystemServer();
Dianne Hackbornd6847842010-01-12 18:14:19 -08003450 }
3451 }
3452 }
Amith Yamasani71e6c692013-03-24 17:39:28 -07003453
3454 /**
Michal Karpinskied5c8f02016-02-09 15:43:41 +00003455 * @hide
3456 */
3457 public void reportFailedFingerprintAttempt(int userHandle) {
3458 if (mService != null) {
3459 try {
3460 mService.reportFailedFingerprintAttempt(userHandle);
3461 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07003462 throw e.rethrowFromSystemServer();
Michal Karpinskied5c8f02016-02-09 15:43:41 +00003463 }
3464 }
3465 }
3466
3467 /**
3468 * @hide
3469 */
3470 public void reportSuccessfulFingerprintAttempt(int userHandle) {
3471 if (mService != null) {
3472 try {
3473 mService.reportSuccessfulFingerprintAttempt(userHandle);
3474 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07003475 throw e.rethrowFromSystemServer();
Michal Karpinskied5c8f02016-02-09 15:43:41 +00003476 }
3477 }
3478 }
3479
3480 /**
Michal Karpinski31502d32016-01-25 16:43:07 +00003481 * Should be called when keyguard has been dismissed.
3482 * @hide
3483 */
Michal Karpinskied5c8f02016-02-09 15:43:41 +00003484 public void reportKeyguardDismissed(int userHandle) {
Michal Karpinski31502d32016-01-25 16:43:07 +00003485 if (mService != null) {
3486 try {
Michal Karpinskied5c8f02016-02-09 15:43:41 +00003487 mService.reportKeyguardDismissed(userHandle);
Michal Karpinski31502d32016-01-25 16:43:07 +00003488 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07003489 throw e.rethrowFromSystemServer();
Michal Karpinski31502d32016-01-25 16:43:07 +00003490 }
3491 }
3492 }
3493
3494 /**
3495 * Should be called when keyguard view has been shown to the user.
3496 * @hide
3497 */
Michal Karpinskied5c8f02016-02-09 15:43:41 +00003498 public void reportKeyguardSecured(int userHandle) {
Michal Karpinski31502d32016-01-25 16:43:07 +00003499 if (mService != null) {
3500 try {
Michal Karpinskied5c8f02016-02-09 15:43:41 +00003501 mService.reportKeyguardSecured(userHandle);
Michal Karpinski31502d32016-01-25 16:43:07 +00003502 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07003503 throw e.rethrowFromSystemServer();
Michal Karpinski31502d32016-01-25 16:43:07 +00003504 }
3505 }
3506 }
3507
3508 /**
Amith Yamasani71e6c692013-03-24 17:39:28 -07003509 * @hide
Nicolas Prevot28063742015-01-08 15:37:12 +00003510 * Sets the given package as the device owner.
Makoto Onukia52562c2015-10-01 16:12:31 -07003511 * Same as {@link #setDeviceOwner(ComponentName, String)} but without setting a device owner name.
3512 * @param who the component name to be registered as device owner.
Amith Yamasani71e6c692013-03-24 17:39:28 -07003513 * @return whether the package was successfully registered as the device owner.
3514 * @throws IllegalArgumentException if the package name is null or invalid
Nicolas Prevot28063742015-01-08 15:37:12 +00003515 * @throws IllegalStateException If the preconditions mentioned are not met.
Amith Yamasani71e6c692013-03-24 17:39:28 -07003516 */
Makoto Onukia52562c2015-10-01 16:12:31 -07003517 public boolean setDeviceOwner(ComponentName who) {
3518 return setDeviceOwner(who, null);
Geoffrey Borggaard334c7e32013-08-08 14:31:36 -04003519 }
3520
3521 /**
3522 * @hide
Makoto Onuki58b684f2015-09-04 10:48:16 -07003523 */
Makoto Onukia52562c2015-10-01 16:12:31 -07003524 public boolean setDeviceOwner(ComponentName who, int userId) {
3525 return setDeviceOwner(who, null, userId);
Makoto Onuki58b684f2015-09-04 10:48:16 -07003526 }
3527
3528 /**
3529 * @hide
3530 */
Makoto Onukia52562c2015-10-01 16:12:31 -07003531 public boolean setDeviceOwner(ComponentName who, String ownerName) {
3532 return setDeviceOwner(who, ownerName, UserHandle.USER_SYSTEM);
Makoto Onuki58b684f2015-09-04 10:48:16 -07003533 }
3534
3535 /**
3536 * @hide
Nicolas Prevot28063742015-01-08 15:37:12 +00003537 * Sets the given package as the device owner. The package must already be installed. There
3538 * must not already be a device owner.
3539 * Only apps with the MANAGE_PROFILE_AND_DEVICE_OWNERS permission and the shell uid can call
3540 * this method.
3541 * Calling this after the setup phase of the primary user has completed is allowed only if
3542 * the caller is the shell uid, and there are no additional users and no accounts.
Makoto Onukia52562c2015-10-01 16:12:31 -07003543 * @param who the component name to be registered as device owner.
Geoffrey Borggaard334c7e32013-08-08 14:31:36 -04003544 * @param ownerName the human readable name of the institution that owns this device.
Makoto Onuki58b684f2015-09-04 10:48:16 -07003545 * @param userId ID of the user on which the device owner runs.
Geoffrey Borggaard334c7e32013-08-08 14:31:36 -04003546 * @return whether the package was successfully registered as the device owner.
3547 * @throws IllegalArgumentException if the package name is null or invalid
Nicolas Prevot28063742015-01-08 15:37:12 +00003548 * @throws IllegalStateException If the preconditions mentioned are not met.
Geoffrey Borggaard334c7e32013-08-08 14:31:36 -04003549 */
Makoto Onukia52562c2015-10-01 16:12:31 -07003550 public boolean setDeviceOwner(ComponentName who, String ownerName, int userId)
Geoffrey Borggaard334c7e32013-08-08 14:31:36 -04003551 throws IllegalArgumentException, IllegalStateException {
Amith Yamasani71e6c692013-03-24 17:39:28 -07003552 if (mService != null) {
3553 try {
Makoto Onukia52562c2015-10-01 16:12:31 -07003554 return mService.setDeviceOwner(who, ownerName, userId);
Amith Yamasani71e6c692013-03-24 17:39:28 -07003555 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07003556 throw re.rethrowFromSystemServer();
Amith Yamasani71e6c692013-03-24 17:39:28 -07003557 }
3558 }
3559 return false;
3560 }
3561
3562 /**
Amith Yamasani3b458ad2013-04-18 18:40:07 -07003563 * Used to determine if a particular package has been registered as a Device Owner app.
3564 * A device owner app is a special device admin that cannot be deactivated by the user, once
Robin Lee25e26452015-06-02 09:56:29 -07003565 * activated as a device admin. It also cannot be uninstalled. To check whether a particular
Amith Yamasani3b458ad2013-04-18 18:40:07 -07003566 * package is currently registered as the device owner app, pass in the package name from
3567 * {@link Context#getPackageName()} to this method.<p/>This is useful for device
Robin Lee25e26452015-06-02 09:56:29 -07003568 * admin apps that want to check whether they are also registered as the device owner app. The
Amith Yamasani3b458ad2013-04-18 18:40:07 -07003569 * exact mechanism by which a device admin app is registered as a device owner app is defined by
3570 * the setup process.
3571 * @param packageName the package name of the app, to compare with the registered device owner
3572 * app, if any.
Makoto Onukic8a5a552015-11-19 14:29:12 -08003573 * @return whether or not the package is registered as the device owner app.
Amith Yamasani71e6c692013-03-24 17:39:28 -07003574 */
Amith Yamasani3b458ad2013-04-18 18:40:07 -07003575 public boolean isDeviceOwnerApp(String packageName) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01003576 throwIfParentInstance("isDeviceOwnerApp");
Makoto Onukic8a5a552015-11-19 14:29:12 -08003577 return isDeviceOwnerAppOnCallingUser(packageName);
3578 }
3579
3580 /**
3581 * @return true if a package is registered as device owner, only when it's running on the
3582 * calling user.
3583 *
3584 * <p>Same as {@link #isDeviceOwnerApp}, but bundled code should use it for clarity.
3585 * @hide
3586 */
3587 public boolean isDeviceOwnerAppOnCallingUser(String packageName) {
3588 return isDeviceOwnerAppOnAnyUserInner(packageName, /* callingUserOnly =*/ true);
3589 }
3590
3591 /**
3592 * @return true if a package is registered as device owner, even if it's running on a different
3593 * user.
3594 *
3595 * <p>Requires the MANAGE_USERS permission.
3596 *
3597 * @hide
3598 */
3599 public boolean isDeviceOwnerAppOnAnyUser(String packageName) {
3600 return isDeviceOwnerAppOnAnyUserInner(packageName, /* callingUserOnly =*/ false);
3601 }
3602
3603 /**
3604 * @return device owner component name, only when it's running on the calling user.
3605 *
3606 * @hide
3607 */
3608 public ComponentName getDeviceOwnerComponentOnCallingUser() {
3609 return getDeviceOwnerComponentInner(/* callingUserOnly =*/ true);
3610 }
3611
3612 /**
3613 * @return device owner component name, even if it's running on a different user.
3614 *
3615 * <p>Requires the MANAGE_USERS permission.
3616 *
3617 * @hide
3618 */
3619 public ComponentName getDeviceOwnerComponentOnAnyUser() {
3620 return getDeviceOwnerComponentInner(/* callingUserOnly =*/ false);
3621 }
3622
3623 private boolean isDeviceOwnerAppOnAnyUserInner(String packageName, boolean callingUserOnly) {
Makoto Onuki70f929e2015-11-11 12:40:15 -08003624 if (packageName == null) {
3625 return false;
Amith Yamasani71e6c692013-03-24 17:39:28 -07003626 }
Makoto Onukic8a5a552015-11-19 14:29:12 -08003627 final ComponentName deviceOwner = getDeviceOwnerComponentInner(callingUserOnly);
Makoto Onuki70f929e2015-11-11 12:40:15 -08003628 if (deviceOwner == null) {
3629 return false;
3630 }
3631 return packageName.equals(deviceOwner.getPackageName());
Amith Yamasani71e6c692013-03-24 17:39:28 -07003632 }
3633
Makoto Onukic8a5a552015-11-19 14:29:12 -08003634 private ComponentName getDeviceOwnerComponentInner(boolean callingUserOnly) {
3635 if (mService != null) {
3636 try {
3637 return mService.getDeviceOwnerComponent(callingUserOnly);
3638 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07003639 throw re.rethrowFromSystemServer();
Makoto Onukic8a5a552015-11-19 14:29:12 -08003640 }
3641 }
3642 return null;
Amith Yamasani3b458ad2013-04-18 18:40:07 -07003643 }
3644
Jason Monkb0dced82014-06-06 14:36:20 -04003645 /**
Makoto Onukic8a5a552015-11-19 14:29:12 -08003646 * @return ID of the user who runs device owner, or {@link UserHandle#USER_NULL} if there's
3647 * no device owner.
3648 *
3649 * <p>Requires the MANAGE_USERS permission.
Makoto Onukia52562c2015-10-01 16:12:31 -07003650 *
3651 * @hide
3652 */
Makoto Onukic8a5a552015-11-19 14:29:12 -08003653 public int getDeviceOwnerUserId() {
3654 if (mService != null) {
3655 try {
3656 return mService.getDeviceOwnerUserId();
3657 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07003658 throw re.rethrowFromSystemServer();
Makoto Onukic8a5a552015-11-19 14:29:12 -08003659 }
3660 }
3661 return UserHandle.USER_NULL;
Makoto Onukia52562c2015-10-01 16:12:31 -07003662 }
3663
3664 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07003665 * Clears the current device owner. The caller must be the device owner. This function should be
3666 * used cautiously as once it is called it cannot be undone. The device owner can only be set as
3667 * a part of device setup before setup completes.
Jason Monk94d2cf92014-06-18 09:53:34 -04003668 *
3669 * @param packageName The package name of the device owner.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07003670 * @throws SecurityException if the caller is not in {@code packageName} or {@code packageName}
3671 * does not own the current device owner component.
Jason Monkb0dced82014-06-06 14:36:20 -04003672 */
Jason Monk94d2cf92014-06-18 09:53:34 -04003673 public void clearDeviceOwnerApp(String packageName) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01003674 throwIfParentInstance("clearDeviceOwnerApp");
Jason Monkb0dced82014-06-06 14:36:20 -04003675 if (mService != null) {
3676 try {
Jason Monk94d2cf92014-06-18 09:53:34 -04003677 mService.clearDeviceOwner(packageName);
Jason Monkb0dced82014-06-06 14:36:20 -04003678 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07003679 throw re.rethrowFromSystemServer();
Jason Monkb0dced82014-06-06 14:36:20 -04003680 }
3681 }
3682 }
3683
Makoto Onukia52562c2015-10-01 16:12:31 -07003684 /**
Makoto Onukic8a5a552015-11-19 14:29:12 -08003685 * Returns the device owner package name, only if it's running on the calling user.
3686 *
3687 * <p>Bundled components should use {@code getDeviceOwnerComponentOnCallingUser()} for clarity.
Makoto Onukia52562c2015-10-01 16:12:31 -07003688 *
3689 * @hide
3690 */
Nicolas Prevot465acf32014-08-06 17:03:25 +01003691 @SystemApi
Amith Yamasani71e6c692013-03-24 17:39:28 -07003692 public String getDeviceOwner() {
Benjamin Franzbc33c822016-04-15 08:57:52 +01003693 throwIfParentInstance("getDeviceOwner");
Makoto Onukic8a5a552015-11-19 14:29:12 -08003694 final ComponentName name = getDeviceOwnerComponentOnCallingUser();
3695 return name != null ? name.getPackageName() : null;
Makoto Onukia52562c2015-10-01 16:12:31 -07003696 }
3697
3698 /**
Makoto Onukic8a5a552015-11-19 14:29:12 -08003699 * @return true if the device is managed by any device owner.
3700 *
3701 * <p>Requires the MANAGE_USERS permission.
Makoto Onukia52562c2015-10-01 16:12:31 -07003702 *
3703 * @hide
3704 */
Makoto Onukic8a5a552015-11-19 14:29:12 -08003705 public boolean isDeviceManaged() {
3706 return getDeviceOwnerComponentOnAnyUser() != null;
3707 }
3708
3709 /**
3710 * Returns the device owner name. Note this method *will* return the device owner
3711 * name when it's running on a different user.
3712 *
3713 * <p>Requires the MANAGE_USERS permission.
3714 *
3715 * @hide
3716 */
Makoto Onukia2b274b2016-01-19 13:26:02 -08003717 @SystemApi
Makoto Onukic8a5a552015-11-19 14:29:12 -08003718 public String getDeviceOwnerNameOnAnyUser() {
Benjamin Franzbc33c822016-04-15 08:57:52 +01003719 throwIfParentInstance("getDeviceOwnerNameOnAnyUser");
Amith Yamasani71e6c692013-03-24 17:39:28 -07003720 if (mService != null) {
3721 try {
Makoto Onukia52562c2015-10-01 16:12:31 -07003722 return mService.getDeviceOwnerName();
Amith Yamasani71e6c692013-03-24 17:39:28 -07003723 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07003724 throw re.rethrowFromSystemServer();
Geoffrey Borggaard334c7e32013-08-08 14:31:36 -04003725 }
3726 }
3727 return null;
3728 }
Adam Connors776c5552014-01-09 10:42:56 +00003729
3730 /**
Julia Reynolds94e7bf62015-06-10 14:44:56 -04003731 * @hide
Craig Lafayettee7ee54e2015-09-21 13:48:53 -04003732 * @deprecated Do not use
3733 * @removed
Julia Reynolds20118f12015-02-11 12:34:08 -05003734 */
Craig Lafayettee7ee54e2015-09-21 13:48:53 -04003735 @Deprecated
Julia Reynolds20118f12015-02-11 12:34:08 -05003736 @SystemApi
3737 public String getDeviceInitializerApp() {
Julia Reynolds20118f12015-02-11 12:34:08 -05003738 return null;
3739 }
3740
3741 /**
Julia Reynoldseaafdf722015-04-02 08:49:47 -04003742 * @hide
Craig Lafayettee7ee54e2015-09-21 13:48:53 -04003743 * @deprecated Do not use
3744 * @removed
Julia Reynoldseaafdf722015-04-02 08:49:47 -04003745 */
Craig Lafayettee7ee54e2015-09-21 13:48:53 -04003746 @Deprecated
Julia Reynoldseaafdf722015-04-02 08:49:47 -04003747 @SystemApi
3748 public ComponentName getDeviceInitializerComponent() {
Julia Reynoldseaafdf722015-04-02 08:49:47 -04003749 return null;
3750 }
3751
Julia Reynolds20118f12015-02-11 12:34:08 -05003752 /**
Adam Connors776c5552014-01-09 10:42:56 +00003753 * @hide
Amith Yamasanibf3a9462014-07-28 14:26:42 -07003754 * @deprecated Use #ACTION_SET_PROFILE_OWNER
Amith Yamasaniaba4f1b2014-07-01 15:36:12 +05303755 * Sets the given component as an active admin and registers the package as the profile
3756 * owner for this user. The package must already be installed and there shouldn't be
3757 * an existing profile owner registered for this user. Also, this method must be called
3758 * before the user setup has been completed.
3759 * <p>
3760 * This method can only be called by system apps that hold MANAGE_USERS permission and
3761 * MANAGE_DEVICE_ADMINS permission.
3762 * @param admin The component to register as an active admin and profile owner.
3763 * @param ownerName The user-visible name of the entity that is managing this user.
3764 * @return whether the admin was successfully registered as the profile owner.
3765 * @throws IllegalArgumentException if packageName is null, the package isn't installed, or
3766 * the user has already been set up.
3767 */
Justin Morey80440cc2014-07-24 09:16:35 -05003768 @SystemApi
Robin Lee25e26452015-06-02 09:56:29 -07003769 public boolean setActiveProfileOwner(@NonNull ComponentName admin, @Deprecated String ownerName)
Amith Yamasaniaba4f1b2014-07-01 15:36:12 +05303770 throws IllegalArgumentException {
Benjamin Franzbc33c822016-04-15 08:57:52 +01003771 throwIfParentInstance("setActiveProfileOwner");
Amith Yamasaniaba4f1b2014-07-01 15:36:12 +05303772 if (mService != null) {
3773 try {
Makoto Onukicc4bbeb2015-09-17 10:28:24 -07003774 final int myUserId = myUserId();
Amith Yamasaniaba4f1b2014-07-01 15:36:12 +05303775 mService.setActiveAdmin(admin, false, myUserId);
Amith Yamasanibf3a9462014-07-28 14:26:42 -07003776 return mService.setProfileOwner(admin, ownerName, myUserId);
Amith Yamasaniaba4f1b2014-07-01 15:36:12 +05303777 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07003778 throw re.rethrowFromSystemServer();
Amith Yamasaniaba4f1b2014-07-01 15:36:12 +05303779 }
3780 }
3781 return false;
3782 }
3783
3784 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07003785 * Clears the active profile owner and removes all user restrictions. The caller must be from
3786 * the same package as the active profile owner for this user, otherwise a SecurityException
3787 * will be thrown.
3788 * <p>
3789 * This doesn't work for managed profile owners.
Makoto Onuki5bf68022016-01-27 13:49:19 -08003790 *
Amith Yamasanibf3a9462014-07-28 14:26:42 -07003791 * @param admin The component to remove as the profile owner.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07003792 * @throws SecurityException if {@code admin} is not an active profile owner.
Amith Yamasanibf3a9462014-07-28 14:26:42 -07003793 */
Robin Lee25e26452015-06-02 09:56:29 -07003794 public void clearProfileOwner(@NonNull ComponentName admin) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01003795 throwIfParentInstance("clearProfileOwner");
Amith Yamasanibf3a9462014-07-28 14:26:42 -07003796 if (mService != null) {
3797 try {
3798 mService.clearProfileOwner(admin);
3799 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07003800 throw re.rethrowFromSystemServer();
Amith Yamasanibf3a9462014-07-28 14:26:42 -07003801 }
3802 }
3803 }
3804
3805 /**
Julia Reynoldse9254402015-02-11 12:34:08 -05003806 * @hide
Robin Lee25e26452015-06-02 09:56:29 -07003807 * Checks whether the user was already setup.
Amith Yamasanibf3a9462014-07-28 14:26:42 -07003808 */
3809 public boolean hasUserSetupCompleted() {
3810 if (mService != null) {
3811 try {
3812 return mService.hasUserSetupCompleted();
3813 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07003814 throw re.rethrowFromSystemServer();
Amith Yamasanibf3a9462014-07-28 14:26:42 -07003815 }
3816 }
3817 return true;
3818 }
3819
3820 /**
Amith Yamasanibf3a9462014-07-28 14:26:42 -07003821 * @hide
3822 * Sets the given component as the profile owner of the given user profile. The package must
Nicolas Prevot28063742015-01-08 15:37:12 +00003823 * already be installed. There must not already be a profile owner for this user.
3824 * Only apps with the MANAGE_PROFILE_AND_DEVICE_OWNERS permission and the shell uid can call
3825 * this method.
3826 * Calling this after the setup phase of the specified user has completed is allowed only if:
3827 * - the caller is SYSTEM_UID.
3828 * - or the caller is the shell uid, and there are no accounts on the specified user.
Amith Yamasanibf3a9462014-07-28 14:26:42 -07003829 * @param admin the component name to be registered as profile owner.
3830 * @param ownerName the human readable name of the organisation associated with this DPM.
3831 * @param userHandle the userId to set the profile owner for.
3832 * @return whether the component was successfully registered as the profile owner.
Nicolas Prevot28063742015-01-08 15:37:12 +00003833 * @throws IllegalArgumentException if admin is null, the package isn't installed, or the
3834 * preconditions mentioned are not met.
Amith Yamasanibf3a9462014-07-28 14:26:42 -07003835 */
Robin Lee25e26452015-06-02 09:56:29 -07003836 public boolean setProfileOwner(@NonNull ComponentName admin, @Deprecated String ownerName,
Robin Leeddd553f2015-04-30 14:18:22 +01003837 int userHandle) throws IllegalArgumentException {
Adam Connors776c5552014-01-09 10:42:56 +00003838 if (mService != null) {
3839 try {
Amith Yamasanibf3a9462014-07-28 14:26:42 -07003840 if (ownerName == null) {
3841 ownerName = "";
3842 }
3843 return mService.setProfileOwner(admin, ownerName, userHandle);
Adam Connors776c5552014-01-09 10:42:56 +00003844 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07003845 throw re.rethrowFromSystemServer();
Adam Connors776c5552014-01-09 10:42:56 +00003846 }
3847 }
3848 return false;
3849 }
3850
3851 /**
Andrei Stingaceanu6644cd92015-11-10 13:03:31 +00003852 * Sets the device owner information to be shown on the lock screen.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07003853 * <p>
3854 * If the device owner information is {@code null} or empty then the device owner info is
Andrei Stingaceanu6644cd92015-11-10 13:03:31 +00003855 * cleared and the user owner info is shown on the lock screen if it is set.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07003856 * <p>
3857 * If the device owner information contains only whitespaces then the message on the lock screen
3858 * will be blank and the user will not be allowed to change it.
3859 * <p>
3860 * If the device owner information needs to be localized, it is the responsibility of the
Benjamin Franz3e8a7092016-01-25 16:19:08 +00003861 * {@link DeviceAdminReceiver} to listen to the {@link Intent#ACTION_LOCALE_CHANGED} broadcast
3862 * and set a new version of this string accordingly.
3863 *
Andrei Stingaceanu6644cd92015-11-10 13:03:31 +00003864 * @param admin The name of the admin component to check.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07003865 * @param info Device owner information which will be displayed instead of the user owner info.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07003866 * @throws SecurityException if {@code admin} is not a device owner.
Andrei Stingaceanu6644cd92015-11-10 13:03:31 +00003867 */
Andrei Stingaceanu16187902016-03-21 15:44:45 +00003868 public void setDeviceOwnerLockScreenInfo(@NonNull ComponentName admin, CharSequence info) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01003869 throwIfParentInstance("setDeviceOwnerLockScreenInfo");
Andrei Stingaceanu6644cd92015-11-10 13:03:31 +00003870 if (mService != null) {
3871 try {
Andrei Stingaceanu16187902016-03-21 15:44:45 +00003872 mService.setDeviceOwnerLockScreenInfo(admin, info);
Andrei Stingaceanu6644cd92015-11-10 13:03:31 +00003873 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07003874 throw re.rethrowFromSystemServer();
Andrei Stingaceanu6644cd92015-11-10 13:03:31 +00003875 }
3876 }
Andrei Stingaceanu6644cd92015-11-10 13:03:31 +00003877 }
3878
3879 /**
3880 * @return The device owner information. If it is not set returns {@code null}.
3881 */
Andrei Stingaceanu16187902016-03-21 15:44:45 +00003882 public CharSequence getDeviceOwnerLockScreenInfo() {
Benjamin Franzbc33c822016-04-15 08:57:52 +01003883 throwIfParentInstance("getDeviceOwnerLockScreenInfo");
Andrei Stingaceanu6644cd92015-11-10 13:03:31 +00003884 if (mService != null) {
3885 try {
3886 return mService.getDeviceOwnerLockScreenInfo();
3887 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07003888 throw re.rethrowFromSystemServer();
Andrei Stingaceanu6644cd92015-11-10 13:03:31 +00003889 }
3890 }
3891 return null;
3892 }
3893
3894 /**
Andrei Stingaceanueb84b182016-01-26 18:39:55 +00003895 * Called by device or profile owners to suspend packages for this user.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07003896 * <p>
3897 * A suspended package will not be able to start activities. Its notifications will be hidden,
3898 * it will not show up in recents, will not be able to show toasts or dialogs or ring the
3899 * device.
3900 * <p>
3901 * The package must already be installed. If the package is uninstalled while suspended the
3902 * package will no longer be suspended. The admin can block this by using
Kenny Guy871f3eb2016-03-09 20:06:16 +00003903 * {@link #setUninstallBlocked}.
Andrei Stingaceanu1e283912015-11-26 15:26:28 +00003904 *
3905 * @param admin The name of the admin component to check.
Andrei Stingaceanueb84b182016-01-26 18:39:55 +00003906 * @param packageNames The package names to suspend or unsuspend.
3907 * @param suspended If set to {@code true} than the packages will be suspended, if set to
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07003908 * {@code false} the packages will be unsuspended.
Andrei Stingaceanueb84b182016-01-26 18:39:55 +00003909 * @return an array of package names for which the suspended status is not set as requested in
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07003910 * this method.
3911 * @throws SecurityException if {@code admin} is not a device or profile owner.
Andrei Stingaceanu1e283912015-11-26 15:26:28 +00003912 */
Andrei Stingaceanueb84b182016-01-26 18:39:55 +00003913 public String[] setPackagesSuspended(@NonNull ComponentName admin, String[] packageNames,
Andrei Stingaceanu1e283912015-11-26 15:26:28 +00003914 boolean suspended) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01003915 throwIfParentInstance("setPackagesSuspended");
Andrei Stingaceanu1e283912015-11-26 15:26:28 +00003916 if (mService != null) {
3917 try {
Andrei Stingaceanueb84b182016-01-26 18:39:55 +00003918 return mService.setPackagesSuspended(admin, packageNames, suspended);
Andrei Stingaceanu1e283912015-11-26 15:26:28 +00003919 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07003920 throw re.rethrowFromSystemServer();
Andrei Stingaceanu1e283912015-11-26 15:26:28 +00003921 }
3922 }
Andrei Stingaceanueb84b182016-01-26 18:39:55 +00003923 return packageNames;
Andrei Stingaceanu1e283912015-11-26 15:26:28 +00003924 }
3925
3926 /**
3927 * Called by device or profile owners to determine if a package is suspended.
3928 *
3929 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
3930 * @param packageName The name of the package to retrieve the suspended status of.
Andrei Stingaceanu355b2322016-02-12 16:43:51 +00003931 * @return {@code true} if the package is suspended or {@code false} if the package is not
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07003932 * suspended, could not be found or an error occurred.
3933 * @throws SecurityException if {@code admin} is not a device or profile owner.
Andrei Stingaceanuefc4a342016-03-22 14:43:01 +00003934 * @throws NameNotFoundException if the package could not be found.
Andrei Stingaceanu1e283912015-11-26 15:26:28 +00003935 */
Andrei Stingaceanuefc4a342016-03-22 14:43:01 +00003936 public boolean isPackageSuspended(@NonNull ComponentName admin, String packageName)
3937 throws NameNotFoundException {
Benjamin Franzbc33c822016-04-15 08:57:52 +01003938 throwIfParentInstance("isPackageSuspended");
Andrei Stingaceanu1e283912015-11-26 15:26:28 +00003939 if (mService != null) {
3940 try {
Andrei Stingaceanuefc4a342016-03-22 14:43:01 +00003941 return mService.isPackageSuspended(admin, packageName);
Andrei Stingaceanu1e283912015-11-26 15:26:28 +00003942 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07003943 throw e.rethrowFromSystemServer();
Andrei Stingaceanuefc4a342016-03-22 14:43:01 +00003944 } catch (IllegalArgumentException ex) {
3945 throw new NameNotFoundException(packageName);
Andrei Stingaceanu1e283912015-11-26 15:26:28 +00003946 }
3947 }
3948 return false;
3949 }
3950
3951 /**
Alexandra Gherghina512675b2014-04-02 11:23:54 +01003952 * Sets the enabled state of the profile. A profile should be enabled only once it is ready to
3953 * be used. Only the profile owner can call this.
3954 *
Alexandra Gherghinadf35d572014-04-09 13:54:39 +01003955 * @see #isProfileOwnerApp
Alexandra Gherghina512675b2014-04-02 11:23:54 +01003956 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07003957 * @throws SecurityException if {@code admin} is not a profile owner.
Alexandra Gherghina512675b2014-04-02 11:23:54 +01003958 */
Robin Lee25e26452015-06-02 09:56:29 -07003959 public void setProfileEnabled(@NonNull ComponentName admin) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01003960 throwIfParentInstance("setProfileEnabled");
Alexandra Gherghina512675b2014-04-02 11:23:54 +01003961 if (mService != null) {
3962 try {
3963 mService.setProfileEnabled(admin);
3964 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07003965 throw e.rethrowFromSystemServer();
Alexandra Gherghina512675b2014-04-02 11:23:54 +01003966 }
3967 }
3968 }
3969
3970 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07003971 * Sets the name of the profile. In the device owner case it sets the name of the user which it
3972 * is called from. Only a profile owner or device owner can call this. If this is never called
3973 * by the profile or device owner, the name will be set to default values.
Jessica Hummel1333ea12014-06-23 11:20:10 +01003974 *
3975 * @see #isProfileOwnerApp
3976 * @see #isDeviceOwnerApp
Robin Lee25e26452015-06-02 09:56:29 -07003977 * @param admin Which {@link DeviceAdminReceiver} this request is associate with.
Jessica Hummel1333ea12014-06-23 11:20:10 +01003978 * @param profileName The name of the profile.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07003979 * @throws SecurityException if {@code admin} is not a device or profile owner.
Jessica Hummel1333ea12014-06-23 11:20:10 +01003980 */
Robin Lee25e26452015-06-02 09:56:29 -07003981 public void setProfileName(@NonNull ComponentName admin, String profileName) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01003982 throwIfParentInstance("setProfileName");
Jessica Hummel1333ea12014-06-23 11:20:10 +01003983 if (mService != null) {
3984 try {
Robin Lee25e26452015-06-02 09:56:29 -07003985 mService.setProfileName(admin, profileName);
Fyodor Kupolov78f13142015-05-27 16:52:45 -07003986 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07003987 throw e.rethrowFromSystemServer();
Fyodor Kupolov78f13142015-05-27 16:52:45 -07003988 }
Jessica Hummel1333ea12014-06-23 11:20:10 +01003989 }
3990 }
Jessica Hummel1333ea12014-06-23 11:20:10 +01003991
3992 /**
Amith Yamasanic34dc7c2014-09-18 09:42:42 -07003993 * Used to determine if a particular package is registered as the profile owner for the
Makoto Onuki32b30572015-12-11 14:29:51 -08003994 * user. A profile owner is a special device admin that has additional privileges
Amith Yamasanic34dc7c2014-09-18 09:42:42 -07003995 * within the profile.
Adam Connors776c5552014-01-09 10:42:56 +00003996 *
3997 * @param packageName The package name of the app to compare with the registered profile owner.
3998 * @return Whether or not the package is registered as the profile owner.
3999 */
4000 public boolean isProfileOwnerApp(String packageName) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01004001 throwIfParentInstance("isProfileOwnerApp");
Adam Connors776c5552014-01-09 10:42:56 +00004002 if (mService != null) {
4003 try {
Makoto Onuki90b89652016-01-28 14:44:18 -08004004 ComponentName profileOwner = mService.getProfileOwner(myUserId());
Nicolas Prevot90af6d72014-07-30 14:19:12 +01004005 return profileOwner != null
4006 && profileOwner.getPackageName().equals(packageName);
Adam Connors776c5552014-01-09 10:42:56 +00004007 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07004008 throw re.rethrowFromSystemServer();
Adam Connors776c5552014-01-09 10:42:56 +00004009 }
4010 }
4011 return false;
4012 }
4013
4014 /**
4015 * @hide
Robin Lee25e26452015-06-02 09:56:29 -07004016 * @return the packageName of the owner of the given user profile or {@code null} if no profile
Adam Connors776c5552014-01-09 10:42:56 +00004017 * owner has been set for that user.
4018 * @throws IllegalArgumentException if the userId is invalid.
4019 */
Nicolas Prevot465acf32014-08-06 17:03:25 +01004020 @SystemApi
Amith Yamasanibf3a9462014-07-28 14:26:42 -07004021 public ComponentName getProfileOwner() throws IllegalArgumentException {
Benjamin Franzbc33c822016-04-15 08:57:52 +01004022 throwIfParentInstance("getProfileOwner");
Zoltan Szatmary-Ban3f1ddf82014-07-02 16:42:05 +01004023 return getProfileOwnerAsUser(Process.myUserHandle().getIdentifier());
4024 }
4025
4026 /**
4027 * @see #getProfileOwner()
4028 * @hide
4029 */
4030 public ComponentName getProfileOwnerAsUser(final int userId) throws IllegalArgumentException {
Adam Connors776c5552014-01-09 10:42:56 +00004031 if (mService != null) {
4032 try {
Zoltan Szatmary-Ban3f1ddf82014-07-02 16:42:05 +01004033 return mService.getProfileOwner(userId);
Adam Connors776c5552014-01-09 10:42:56 +00004034 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07004035 throw re.rethrowFromSystemServer();
Adam Connors776c5552014-01-09 10:42:56 +00004036 }
4037 }
4038 return null;
4039 }
4040
4041 /**
4042 * @hide
Robin Lee25e26452015-06-02 09:56:29 -07004043 * @return the human readable name of the organisation associated with this DPM or {@code null}
4044 * if one is not set.
Adam Connors776c5552014-01-09 10:42:56 +00004045 * @throws IllegalArgumentException if the userId is invalid.
4046 */
4047 public String getProfileOwnerName() throws IllegalArgumentException {
4048 if (mService != null) {
4049 try {
4050 return mService.getProfileOwnerName(Process.myUserHandle().getIdentifier());
4051 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07004052 throw re.rethrowFromSystemServer();
Adam Connors776c5552014-01-09 10:42:56 +00004053 }
4054 }
4055 return null;
4056 }
Sander Alewijnsef475ca32014-02-17 15:13:58 +00004057
4058 /**
Amith Yamasani38f836b2014-08-20 14:51:15 -07004059 * @hide
Makoto Onukic8a5a552015-11-19 14:29:12 -08004060 * @param userId The user for whom to fetch the profile owner name, if any.
Amith Yamasani38f836b2014-08-20 14:51:15 -07004061 * @return the human readable name of the organisation associated with this profile owner or
4062 * null if one is not set.
4063 * @throws IllegalArgumentException if the userId is invalid.
4064 */
4065 @SystemApi
Selim Cinek24ac55e2014-08-27 12:51:45 +02004066 public String getProfileOwnerNameAsUser(int userId) throws IllegalArgumentException {
Benjamin Franzbc33c822016-04-15 08:57:52 +01004067 throwIfParentInstance("getProfileOwnerNameAsUser");
Amith Yamasani38f836b2014-08-20 14:51:15 -07004068 if (mService != null) {
4069 try {
Selim Cinek24ac55e2014-08-27 12:51:45 +02004070 return mService.getProfileOwnerName(userId);
Amith Yamasani38f836b2014-08-20 14:51:15 -07004071 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07004072 throw re.rethrowFromSystemServer();
Amith Yamasani38f836b2014-08-20 14:51:15 -07004073 }
4074 }
4075 return null;
4076 }
4077
4078 /**
Sander Alewijnsef475ca32014-02-17 15:13:58 +00004079 * Called by a profile owner or device owner to add a default intent handler activity for
4080 * intents that match a certain intent filter. This activity will remain the default intent
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004081 * handler even if the set of potential event handlers for the intent filter changes and if the
4082 * intent preferences are reset.
4083 * <p>
4084 * The default disambiguation mechanism takes over if the activity is not installed (anymore).
4085 * When the activity is (re)installed, it is automatically reset as default intent handler for
4086 * the filter.
4087 * <p>
4088 * The calling device admin must be a profile owner or device owner. If it is not, a security
4089 * exception will be thrown.
Sander Alewijnsef475ca32014-02-17 15:13:58 +00004090 *
4091 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
4092 * @param filter The IntentFilter for which a default handler is added.
4093 * @param activity The Activity that is added as default intent handler.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004094 * @throws SecurityException if {@code admin} is not a device or profile owner.
Sander Alewijnsef475ca32014-02-17 15:13:58 +00004095 */
Robin Lee25e26452015-06-02 09:56:29 -07004096 public void addPersistentPreferredActivity(@NonNull ComponentName admin, IntentFilter filter,
4097 @NonNull ComponentName activity) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01004098 throwIfParentInstance("addPersistentPreferredActivity");
Sander Alewijnsef475ca32014-02-17 15:13:58 +00004099 if (mService != null) {
4100 try {
4101 mService.addPersistentPreferredActivity(admin, filter, activity);
4102 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07004103 throw e.rethrowFromSystemServer();
Sander Alewijnsef475ca32014-02-17 15:13:58 +00004104 }
4105 }
4106 }
4107
4108 /**
4109 * Called by a profile owner or device owner to remove all persistent intent handler preferences
Torne (Richard Coles)875e2102014-02-24 14:11:56 +00004110 * associated with the given package that were set by {@link #addPersistentPreferredActivity}.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004111 * <p>
4112 * The calling device admin must be a profile owner. If it is not, a security exception will be
4113 * thrown.
Sander Alewijnsef475ca32014-02-17 15:13:58 +00004114 *
4115 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
4116 * @param packageName The name of the package for which preferences are removed.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004117 * @throws SecurityException if {@code admin} is not a device or profile owner.
Sander Alewijnsef475ca32014-02-17 15:13:58 +00004118 */
Robin Lee25e26452015-06-02 09:56:29 -07004119 public void clearPackagePersistentPreferredActivities(@NonNull ComponentName admin,
Sander Alewijnsef475ca32014-02-17 15:13:58 +00004120 String packageName) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01004121 throwIfParentInstance("clearPackagePersistentPreferredActivities");
Sander Alewijnsef475ca32014-02-17 15:13:58 +00004122 if (mService != null) {
4123 try {
4124 mService.clearPackagePersistentPreferredActivities(admin, packageName);
4125 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07004126 throw e.rethrowFromSystemServer();
Sander Alewijnsef475ca32014-02-17 15:13:58 +00004127 }
4128 }
4129 }
Robin Lee66e5d962014-04-09 16:44:21 +01004130
4131 /**
Esteban Talaverabf60f722015-12-10 16:26:44 +00004132 * Called by a profile owner or device owner to grant permission to a package to manage
4133 * application restrictions for the calling user via {@link #setApplicationRestrictions} and
4134 * {@link #getApplicationRestrictions}.
4135 * <p>
4136 * This permission is persistent until it is later cleared by calling this method with a
4137 * {@code null} value or uninstalling the managing package.
Rubin Xuf03d0a62016-02-10 14:54:15 +00004138 * <p>
4139 * The supplied application restriction managing package must be installed when calling this
Victor Changcd14c0a2016-03-16 19:10:15 +00004140 * API, otherwise an {@link NameNotFoundException} will be thrown.
Esteban Talaverabf60f722015-12-10 16:26:44 +00004141 *
4142 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
4143 * @param packageName The package name which will be given access to application restrictions
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004144 * APIs. If {@code null} is given the current package will be cleared.
4145 * @throws SecurityException if {@code admin} is not a device or profile owner.
Victor Changcd14c0a2016-03-16 19:10:15 +00004146 * @throws NameNotFoundException if {@code packageName} is not found
Esteban Talaverabf60f722015-12-10 16:26:44 +00004147 */
4148 public void setApplicationRestrictionsManagingPackage(@NonNull ComponentName admin,
Victor Changcd14c0a2016-03-16 19:10:15 +00004149 @Nullable String packageName) throws NameNotFoundException {
Benjamin Franzbc33c822016-04-15 08:57:52 +01004150 throwIfParentInstance("setApplicationRestrictionsManagingPackage");
Esteban Talaverabf60f722015-12-10 16:26:44 +00004151 if (mService != null) {
4152 try {
Victor Changcd14c0a2016-03-16 19:10:15 +00004153 if (!mService.setApplicationRestrictionsManagingPackage(admin, packageName)) {
4154 throw new NameNotFoundException(packageName);
4155 }
Esteban Talaverabf60f722015-12-10 16:26:44 +00004156 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07004157 throw e.rethrowFromSystemServer();
Esteban Talaverabf60f722015-12-10 16:26:44 +00004158 }
4159 }
4160 }
4161
4162 /**
4163 * Called by a profile owner or device owner to retrieve the application restrictions managing
4164 * package for the current user, or {@code null} if none is set.
4165 *
4166 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
4167 * @return The package name allowed to manage application restrictions on the current user, or
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004168 * {@code null} if none is set.
4169 * @throws SecurityException if {@code admin} is not a device or profile owner.
Esteban Talaverabf60f722015-12-10 16:26:44 +00004170 */
4171 public String getApplicationRestrictionsManagingPackage(@NonNull ComponentName admin) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01004172 throwIfParentInstance("getApplicationRestrictionsManagingPackage");
Esteban Talaverabf60f722015-12-10 16:26:44 +00004173 if (mService != null) {
4174 try {
4175 return mService.getApplicationRestrictionsManagingPackage(admin);
4176 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07004177 throw e.rethrowFromSystemServer();
Esteban Talaverabf60f722015-12-10 16:26:44 +00004178 }
4179 }
4180 return null;
4181 }
4182
4183 /**
Esteban Talavera96895ca2016-03-16 12:00:40 +00004184 * Called by any application to find out whether it has been granted permission via
4185 * {@link #setApplicationRestrictionsManagingPackage} to manage application restrictions
4186 * for the calling user.
4187 *
4188 * <p>This is done by comparing the calling Linux uid with the uid of the package specified by
4189 * that method.
Esteban Talaverabf60f722015-12-10 16:26:44 +00004190 */
4191 public boolean isCallerApplicationRestrictionsManagingPackage() {
Benjamin Franzbc33c822016-04-15 08:57:52 +01004192 throwIfParentInstance("isCallerApplicationRestrictionsManagingPackage");
Esteban Talaverabf60f722015-12-10 16:26:44 +00004193 if (mService != null) {
4194 try {
4195 return mService.isCallerApplicationRestrictionsManagingPackage();
4196 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07004197 throw e.rethrowFromSystemServer();
Esteban Talaverabf60f722015-12-10 16:26:44 +00004198 }
4199 }
4200 return false;
4201 }
4202
4203 /**
4204 * Sets the application restrictions for a given target application running in the calling user.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004205 * <p>
4206 * The caller must be a profile or device owner on that user, or the package allowed to manage
4207 * application restrictions via {@link #setApplicationRestrictionsManagingPackage}; otherwise a
4208 * security exception will be thrown.
4209 * <p>
4210 * The provided {@link Bundle} consists of key-value pairs, where the types of values may be:
Esteban Talavera6b8e0642015-08-10 17:26:04 +01004211 * <ul>
4212 * <li>{@code boolean}
4213 * <li>{@code int}
4214 * <li>{@code String} or {@code String[]}
4215 * <li>From {@link android.os.Build.VERSION_CODES#M}, {@code Bundle} or {@code Bundle[]}
4216 * </ul>
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004217 * <p>
4218 * If the restrictions are not available yet, but may be applied in the near future, the caller
4219 * can notify the target application of that by adding
Sander Alewijnse53d63dc2014-11-07 21:43:00 +00004220 * {@link UserManager#KEY_RESTRICTIONS_PENDING} to the settings parameter.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004221 * <p>
4222 * The application restrictions are only made visible to the target application via
4223 * {@link UserManager#getApplicationRestrictions(String)}, in addition to the profile or device
4224 * owner, and the application restrictions managing package via
Esteban Talaverabf60f722015-12-10 16:26:44 +00004225 * {@link #getApplicationRestrictions}.
Robin Lee66e5d962014-04-09 16:44:21 +01004226 *
Esteban Talaverabf60f722015-12-10 16:26:44 +00004227 * @param admin Which {@link DeviceAdminReceiver} this request is associated with, or
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004228 * {@code null} if called by the application restrictions managing package.
Robin Lee66e5d962014-04-09 16:44:21 +01004229 * @param packageName The name of the package to update restricted settings for.
4230 * @param settings A {@link Bundle} to be parsed by the receiving application, conveying a new
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004231 * set of active restrictions.
4232 * @throws SecurityException if {@code admin} is not a device or profile owner.
Esteban Talaverabf60f722015-12-10 16:26:44 +00004233 * @see #setApplicationRestrictionsManagingPackage
Sander Alewijnse53d63dc2014-11-07 21:43:00 +00004234 * @see UserManager#KEY_RESTRICTIONS_PENDING
Robin Lee66e5d962014-04-09 16:44:21 +01004235 */
Esteban Talaverabf60f722015-12-10 16:26:44 +00004236 public void setApplicationRestrictions(@Nullable ComponentName admin, String packageName,
Robin Lee66e5d962014-04-09 16:44:21 +01004237 Bundle settings) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01004238 throwIfParentInstance("setApplicationRestrictions");
Robin Lee66e5d962014-04-09 16:44:21 +01004239 if (mService != null) {
4240 try {
4241 mService.setApplicationRestrictions(admin, packageName, settings);
4242 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07004243 throw e.rethrowFromSystemServer();
Robin Lee66e5d962014-04-09 16:44:21 +01004244 }
4245 }
4246 }
4247
4248 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004249 * Sets a list of configuration features to enable for a TrustAgent component. This is meant to
4250 * be used in conjunction with {@link #KEYGUARD_DISABLE_TRUST_AGENTS}, which disables all trust
4251 * agents but those enabled by this function call. If flag
Jim Millere303bf42014-08-26 17:12:29 -07004252 * {@link #KEYGUARD_DISABLE_TRUST_AGENTS} is not set, then this call has no effect.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004253 * <p>
4254 * The calling device admin must have requested
4255 * {@link DeviceAdminInfo#USES_POLICY_DISABLE_KEYGUARD_FEATURES} to be able to call this method;
4256 * if not, a security exception will be thrown.
Tony Mak089d8402016-04-05 17:42:55 +01004257 * <p>
4258 * This method can be called on the {@link DevicePolicyManager} instance returned by
4259 * {@link #getParentProfileInstance(ComponentName)} in order to set the configuration for
4260 * the parent profile.
Jim Miller604e7552014-07-18 19:00:02 -07004261 *
4262 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
Jim Millere303bf42014-08-26 17:12:29 -07004263 * @param target Component name of the agent to be enabled.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004264 * @param configuration TrustAgent-specific feature bundle. If null for any admin, agent will be
4265 * strictly disabled according to the state of the
4266 * {@link #KEYGUARD_DISABLE_TRUST_AGENTS} flag.
4267 * <p>
4268 * If {@link #KEYGUARD_DISABLE_TRUST_AGENTS} is set and options is not null for all
4269 * admins, then it's up to the TrustAgent itself to aggregate the values from all
4270 * device admins.
4271 * <p>
4272 * Consult documentation for the specific TrustAgent to determine legal options
4273 * parameters.
4274 * @throws SecurityException if {@code admin} is not an active administrator or does not use
4275 * {@link DeviceAdminInfo#USES_POLICY_DISABLE_KEYGUARD_FEATURES}
Jim Miller604e7552014-07-18 19:00:02 -07004276 */
Robin Lee25e26452015-06-02 09:56:29 -07004277 public void setTrustAgentConfiguration(@NonNull ComponentName admin,
4278 @NonNull ComponentName target, PersistableBundle configuration) {
Jim Miller604e7552014-07-18 19:00:02 -07004279 if (mService != null) {
4280 try {
Tony Mak089d8402016-04-05 17:42:55 +01004281 mService.setTrustAgentConfiguration(admin, target, configuration, mParentInstance);
Jim Miller604e7552014-07-18 19:00:02 -07004282 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07004283 throw e.rethrowFromSystemServer();
Jim Miller604e7552014-07-18 19:00:02 -07004284 }
4285 }
4286 }
4287
4288 /**
Jim Millere303bf42014-08-26 17:12:29 -07004289 * Gets configuration for the given trust agent based on aggregating all calls to
4290 * {@link #setTrustAgentConfiguration(ComponentName, ComponentName, PersistableBundle)} for
4291 * all device admins.
Tony Mak089d8402016-04-05 17:42:55 +01004292 * <p>
4293 * This method can be called on the {@link DevicePolicyManager} instance returned by
4294 * {@link #getParentProfileInstance(ComponentName)} in order to retrieve the configuration set
4295 * on the parent profile.
Jim Miller604e7552014-07-18 19:00:02 -07004296 *
Jim Millerb5db57a2015-01-14 18:17:19 -08004297 * @param admin Which {@link DeviceAdminReceiver} this request is associated with. If null,
4298 * this function returns a list of configurations for all admins that declare
4299 * {@link #KEYGUARD_DISABLE_TRUST_AGENTS}. If any admin declares
4300 * {@link #KEYGUARD_DISABLE_TRUST_AGENTS} but doesn't call
4301 * {@link #setTrustAgentConfiguration(ComponentName, ComponentName, PersistableBundle)}
4302 * for this {@param agent} or calls it with a null configuration, null is returned.
Jim Miller604e7552014-07-18 19:00:02 -07004303 * @param agent Which component to get enabled features for.
Jim Millere303bf42014-08-26 17:12:29 -07004304 * @return configuration for the given trust agent.
Jim Miller604e7552014-07-18 19:00:02 -07004305 */
Robin Lee25e26452015-06-02 09:56:29 -07004306 public List<PersistableBundle> getTrustAgentConfiguration(@Nullable ComponentName admin,
4307 @NonNull ComponentName agent) {
Makoto Onukicc4bbeb2015-09-17 10:28:24 -07004308 return getTrustAgentConfiguration(admin, agent, myUserId());
Jim Millere303bf42014-08-26 17:12:29 -07004309 }
4310
4311 /** @hide per-user version */
Robin Lee25e26452015-06-02 09:56:29 -07004312 public List<PersistableBundle> getTrustAgentConfiguration(@Nullable ComponentName admin,
4313 @NonNull ComponentName agent, int userHandle) {
Jim Miller604e7552014-07-18 19:00:02 -07004314 if (mService != null) {
4315 try {
Tony Mak089d8402016-04-05 17:42:55 +01004316 return mService.getTrustAgentConfiguration(admin, agent, userHandle,
4317 mParentInstance);
Jim Miller604e7552014-07-18 19:00:02 -07004318 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07004319 throw e.rethrowFromSystemServer();
Jim Miller604e7552014-07-18 19:00:02 -07004320 }
4321 }
Jim Millere303bf42014-08-26 17:12:29 -07004322 return new ArrayList<PersistableBundle>(); // empty list
Jim Miller604e7552014-07-18 19:00:02 -07004323 }
4324
4325 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004326 * Called by a profile owner of a managed profile to set whether caller-Id information from the
4327 * managed profile will be shown in the parent profile, for incoming calls.
4328 * <p>
4329 * The calling device admin must be a profile owner. If it is not, a security exception will be
4330 * thrown.
Adam Connors210fe212014-07-17 15:41:43 +01004331 *
Robin Lee25e26452015-06-02 09:56:29 -07004332 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
Adam Connors210fe212014-07-17 15:41:43 +01004333 * @param disabled If true caller-Id information in the managed profile is not displayed.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004334 * @throws SecurityException if {@code admin} is not a device or profile owner.
Adam Connors210fe212014-07-17 15:41:43 +01004335 */
Robin Lee25e26452015-06-02 09:56:29 -07004336 public void setCrossProfileCallerIdDisabled(@NonNull ComponentName admin, boolean disabled) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01004337 throwIfParentInstance("setCrossProfileCallerIdDisabled");
Adam Connors210fe212014-07-17 15:41:43 +01004338 if (mService != null) {
4339 try {
Robin Lee25e26452015-06-02 09:56:29 -07004340 mService.setCrossProfileCallerIdDisabled(admin, disabled);
Adam Connors210fe212014-07-17 15:41:43 +01004341 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07004342 throw e.rethrowFromSystemServer();
Adam Connors210fe212014-07-17 15:41:43 +01004343 }
4344 }
4345 }
4346
4347 /**
Amith Yamasanic34dc7c2014-09-18 09:42:42 -07004348 * Called by a profile owner of a managed profile to determine whether or not caller-Id
4349 * information has been disabled.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004350 * <p>
4351 * The calling device admin must be a profile owner. If it is not, a security exception will be
4352 * thrown.
Adam Connors210fe212014-07-17 15:41:43 +01004353 *
Robin Lee25e26452015-06-02 09:56:29 -07004354 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004355 * @throws SecurityException if {@code admin} is not a device or profile owner.
Adam Connors210fe212014-07-17 15:41:43 +01004356 */
Robin Lee25e26452015-06-02 09:56:29 -07004357 public boolean getCrossProfileCallerIdDisabled(@NonNull ComponentName admin) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01004358 throwIfParentInstance("getCrossProfileCallerIdDisabled");
Adam Connors210fe212014-07-17 15:41:43 +01004359 if (mService != null) {
4360 try {
Robin Lee25e26452015-06-02 09:56:29 -07004361 return mService.getCrossProfileCallerIdDisabled(admin);
Adam Connors210fe212014-07-17 15:41:43 +01004362 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07004363 throw e.rethrowFromSystemServer();
Adam Connors210fe212014-07-17 15:41:43 +01004364 }
4365 }
4366 return false;
4367 }
4368
4369 /**
Amith Yamasani570002f2014-07-18 15:48:54 -07004370 * Determine whether or not caller-Id information has been disabled.
4371 *
4372 * @param userHandle The user for whom to check the caller-id permission
4373 * @hide
4374 */
4375 public boolean getCrossProfileCallerIdDisabled(UserHandle userHandle) {
4376 if (mService != null) {
4377 try {
4378 return mService.getCrossProfileCallerIdDisabledForUser(userHandle.getIdentifier());
4379 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07004380 throw e.rethrowFromSystemServer();
Amith Yamasani570002f2014-07-18 15:48:54 -07004381 }
4382 }
4383 return false;
4384 }
4385
4386 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004387 * Called by a profile owner of a managed profile to set whether contacts search from the
4388 * managed profile will be shown in the parent profile, for incoming calls.
4389 * <p>
4390 * The calling device admin must be a profile owner. If it is not, a security exception will be
4391 * thrown.
Victor Chang1060c6182016-01-04 20:16:23 +00004392 *
4393 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
4394 * @param disabled If true contacts search in the managed profile is not displayed.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004395 * @throws SecurityException if {@code admin} is not a device or profile owner.
Victor Chang1060c6182016-01-04 20:16:23 +00004396 */
4397 public void setCrossProfileContactsSearchDisabled(@NonNull ComponentName admin,
4398 boolean disabled) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01004399 throwIfParentInstance("setCrossProfileContactsSearchDisabled");
Victor Chang1060c6182016-01-04 20:16:23 +00004400 if (mService != null) {
4401 try {
4402 mService.setCrossProfileContactsSearchDisabled(admin, disabled);
4403 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07004404 throw e.rethrowFromSystemServer();
Victor Chang1060c6182016-01-04 20:16:23 +00004405 }
4406 }
4407 }
4408
4409 /**
4410 * Called by a profile owner of a managed profile to determine whether or not contacts search
4411 * has been disabled.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004412 * <p>
4413 * The calling device admin must be a profile owner. If it is not, a security exception will be
4414 * thrown.
Victor Chang1060c6182016-01-04 20:16:23 +00004415 *
4416 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004417 * @throws SecurityException if {@code admin} is not a device or profile owner.
Victor Chang1060c6182016-01-04 20:16:23 +00004418 */
4419 public boolean getCrossProfileContactsSearchDisabled(@NonNull ComponentName admin) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01004420 throwIfParentInstance("getCrossProfileContactsSearchDisabled");
Victor Chang1060c6182016-01-04 20:16:23 +00004421 if (mService != null) {
4422 try {
4423 return mService.getCrossProfileContactsSearchDisabled(admin);
4424 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07004425 throw e.rethrowFromSystemServer();
Victor Chang1060c6182016-01-04 20:16:23 +00004426 }
4427 }
4428 return false;
4429 }
4430
4431
4432 /**
4433 * Determine whether or not contacts search has been disabled.
4434 *
4435 * @param userHandle The user for whom to check the contacts search permission
4436 * @hide
4437 */
4438 public boolean getCrossProfileContactsSearchDisabled(@NonNull UserHandle userHandle) {
4439 if (mService != null) {
4440 try {
4441 return mService
4442 .getCrossProfileContactsSearchDisabledForUser(userHandle.getIdentifier());
4443 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07004444 throw e.rethrowFromSystemServer();
Victor Chang1060c6182016-01-04 20:16:23 +00004445 }
4446 }
4447 return false;
4448 }
4449
4450 /**
Makoto Onuki32b30572015-12-11 14:29:51 -08004451 * Start Quick Contact on the managed profile for the user, if the policy allows.
Victor Chang97bdacc2016-01-21 22:24:11 +00004452 *
Makoto Onuki1040da12015-03-19 11:24:00 -07004453 * @hide
4454 */
4455 public void startManagedQuickContact(String actualLookupKey, long actualContactId,
Victor Chang97bdacc2016-01-21 22:24:11 +00004456 boolean isContactIdIgnored, long directoryId, Intent originalIntent) {
Makoto Onuki1040da12015-03-19 11:24:00 -07004457 if (mService != null) {
4458 try {
Victor Chang97bdacc2016-01-21 22:24:11 +00004459 mService.startManagedQuickContact(actualLookupKey, actualContactId,
4460 isContactIdIgnored, directoryId, originalIntent);
Makoto Onuki1040da12015-03-19 11:24:00 -07004461 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07004462 throw e.rethrowFromSystemServer();
Makoto Onuki1040da12015-03-19 11:24:00 -07004463 }
4464 }
4465 }
4466
4467 /**
Makoto Onuki32b30572015-12-11 14:29:51 -08004468 * Start Quick Contact on the managed profile for the user, if the policy allows.
Ricky Wai494b95d2015-11-20 16:07:15 +00004469 * @hide
4470 */
4471 public void startManagedQuickContact(String actualLookupKey, long actualContactId,
4472 Intent originalIntent) {
Victor Chang97bdacc2016-01-21 22:24:11 +00004473 startManagedQuickContact(actualLookupKey, actualContactId, false, Directory.DEFAULT,
Ricky Wai494b95d2015-11-20 16:07:15 +00004474 originalIntent);
4475 }
4476
4477 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004478 * Called by a profile owner of a managed profile to set whether bluetooth devices can access
4479 * enterprise contacts.
Ricky Wai778ba132015-03-31 14:21:22 +01004480 * <p>
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004481 * The calling device admin must be a profile owner. If it is not, a security exception will be
4482 * thrown.
Ricky Wai778ba132015-03-31 14:21:22 +01004483 * <p>
4484 * This API works on managed profile only.
4485 *
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004486 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
4487 * @param disabled If true, bluetooth devices cannot access enterprise contacts.
4488 * @throws SecurityException if {@code admin} is not a device or profile owner.
Ricky Wai778ba132015-03-31 14:21:22 +01004489 */
Robin Lee25e26452015-06-02 09:56:29 -07004490 public void setBluetoothContactSharingDisabled(@NonNull ComponentName admin, boolean disabled) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01004491 throwIfParentInstance("setBluetoothContactSharingDisabled");
Ricky Wai778ba132015-03-31 14:21:22 +01004492 if (mService != null) {
4493 try {
Robin Lee25e26452015-06-02 09:56:29 -07004494 mService.setBluetoothContactSharingDisabled(admin, disabled);
Ricky Wai778ba132015-03-31 14:21:22 +01004495 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07004496 throw e.rethrowFromSystemServer();
Ricky Wai778ba132015-03-31 14:21:22 +01004497 }
4498 }
4499 }
4500
4501 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004502 * Called by a profile owner of a managed profile to determine whether or not Bluetooth devices
4503 * cannot access enterprise contacts.
Ricky Wai778ba132015-03-31 14:21:22 +01004504 * <p>
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004505 * The calling device admin must be a profile owner. If it is not, a security exception will be
4506 * thrown.
Ricky Wai778ba132015-03-31 14:21:22 +01004507 * <p>
4508 * This API works on managed profile only.
4509 *
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004510 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
4511 * @throws SecurityException if {@code admin} is not a device or profile owner.
Ricky Wai778ba132015-03-31 14:21:22 +01004512 */
Robin Lee25e26452015-06-02 09:56:29 -07004513 public boolean getBluetoothContactSharingDisabled(@NonNull ComponentName admin) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01004514 throwIfParentInstance("getBluetoothContactSharingDisabled");
Ricky Wai778ba132015-03-31 14:21:22 +01004515 if (mService != null) {
4516 try {
Robin Lee25e26452015-06-02 09:56:29 -07004517 return mService.getBluetoothContactSharingDisabled(admin);
Ricky Wai778ba132015-03-31 14:21:22 +01004518 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07004519 throw e.rethrowFromSystemServer();
Ricky Wai778ba132015-03-31 14:21:22 +01004520 }
4521 }
4522 return true;
4523 }
4524
4525 /**
4526 * Determine whether or not Bluetooth devices cannot access contacts.
4527 * <p>
4528 * This API works on managed profile UserHandle only.
4529 *
4530 * @param userHandle The user for whom to check the caller-id permission
4531 * @hide
4532 */
4533 public boolean getBluetoothContactSharingDisabled(UserHandle userHandle) {
4534 if (mService != null) {
4535 try {
4536 return mService.getBluetoothContactSharingDisabledForUser(userHandle
4537 .getIdentifier());
4538 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07004539 throw e.rethrowFromSystemServer();
Ricky Wai778ba132015-03-31 14:21:22 +01004540 }
4541 }
4542 return true;
4543 }
4544
4545 /**
Amith Yamasanic34dc7c2014-09-18 09:42:42 -07004546 * Called by the profile owner of a managed profile so that some intents sent in the managed
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004547 * profile can also be resolved in the parent, or vice versa. Only activity intents are
4548 * supported.
Nicolas Prevotfc7b4442014-12-17 15:28:29 +00004549 *
Nicolas Prevot10fa67c2014-03-24 13:44:38 +00004550 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
Nicolas Prevot81948992014-05-16 18:25:26 +01004551 * @param filter The {@link IntentFilter} the intent has to match to be also resolved in the
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004552 * other profile
Nicolas Prevot41d926e2014-06-09 11:48:56 +01004553 * @param flags {@link DevicePolicyManager#FLAG_MANAGED_CAN_ACCESS_PARENT} and
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004554 * {@link DevicePolicyManager#FLAG_PARENT_CAN_ACCESS_MANAGED} are supported.
4555 * @throws SecurityException if {@code admin} is not a device or profile owner.
Nicolas Prevot10fa67c2014-03-24 13:44:38 +00004556 */
Robin Lee25e26452015-06-02 09:56:29 -07004557 public void addCrossProfileIntentFilter(@NonNull ComponentName admin, IntentFilter filter, int flags) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01004558 throwIfParentInstance("addCrossProfileIntentFilter");
Nicolas Prevot10fa67c2014-03-24 13:44:38 +00004559 if (mService != null) {
4560 try {
Nicolas Prevot81948992014-05-16 18:25:26 +01004561 mService.addCrossProfileIntentFilter(admin, filter, flags);
Nicolas Prevot10fa67c2014-03-24 13:44:38 +00004562 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07004563 throw e.rethrowFromSystemServer();
Nicolas Prevot10fa67c2014-03-24 13:44:38 +00004564 }
4565 }
4566 }
4567
4568 /**
Amith Yamasanic34dc7c2014-09-18 09:42:42 -07004569 * Called by a profile owner of a managed profile to remove the cross-profile intent filters
4570 * that go from the managed profile to the parent, or from the parent to the managed profile.
Nicolas Prevot3f7777f2014-07-24 15:58:39 +01004571 * Only removes those that have been set by the profile owner.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004572 *
Nicolas Prevot10fa67c2014-03-24 13:44:38 +00004573 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004574 * @throws SecurityException if {@code admin} is not a device or profile owner.
Nicolas Prevot10fa67c2014-03-24 13:44:38 +00004575 */
Robin Lee25e26452015-06-02 09:56:29 -07004576 public void clearCrossProfileIntentFilters(@NonNull ComponentName admin) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01004577 throwIfParentInstance("clearCrossProfileIntentFilters");
Nicolas Prevot10fa67c2014-03-24 13:44:38 +00004578 if (mService != null) {
4579 try {
Nicolas Prevot81948992014-05-16 18:25:26 +01004580 mService.clearCrossProfileIntentFilters(admin);
Nicolas Prevot10fa67c2014-03-24 13:44:38 +00004581 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07004582 throw e.rethrowFromSystemServer();
Nicolas Prevot10fa67c2014-03-24 13:44:38 +00004583 }
4584 }
4585 }
4586
4587 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004588 * Called by a profile or device owner to set the permitted accessibility services. When set by
4589 * a device owner or profile owner the restriction applies to all profiles of the user the
4590 * device owner or profile owner is an admin for. By default the user can use any accessiblity
4591 * service. When zero or more packages have been added, accessiblity services that are not in
4592 * the list and not part of the system can not be enabled by the user.
4593 * <p>
4594 * Calling with a null value for the list disables the restriction so that all services can be
4595 * used, calling with an empty list only allows the builtin system's services.
4596 * <p>
4597 * System accesibility services are always available to the user the list can't modify this.
Kenny Guyfa80a4f2014-08-20 19:40:59 +01004598 *
4599 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
4600 * @param packageNames List of accessibility service package names.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004601 * @return true if setting the restriction succeeded. It fail if there is one or more non-system
4602 * accessibility services enabled, that are not in the list.
4603 * @throws SecurityException if {@code admin} is not a device or profile owner.
Kenny Guyfa80a4f2014-08-20 19:40:59 +01004604 */
Robin Lee25e26452015-06-02 09:56:29 -07004605 public boolean setPermittedAccessibilityServices(@NonNull ComponentName admin,
Kenny Guyfa80a4f2014-08-20 19:40:59 +01004606 List<String> packageNames) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01004607 throwIfParentInstance("setPermittedAccessibilityServices");
Kenny Guyfa80a4f2014-08-20 19:40:59 +01004608 if (mService != null) {
4609 try {
4610 return mService.setPermittedAccessibilityServices(admin, packageNames);
4611 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07004612 throw e.rethrowFromSystemServer();
Kenny Guyfa80a4f2014-08-20 19:40:59 +01004613 }
4614 }
4615 return false;
4616 }
4617
4618 /**
4619 * Returns the list of permitted accessibility services set by this device or profile owner.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004620 * <p>
4621 * An empty list means no accessibility services except system services are allowed. Null means
4622 * all accessibility services are allowed.
Kenny Guyfa80a4f2014-08-20 19:40:59 +01004623 *
4624 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
4625 * @return List of accessiblity service package names.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004626 * @throws SecurityException if {@code admin} is not a device or profile owner.
Kenny Guyfa80a4f2014-08-20 19:40:59 +01004627 */
Robin Lee25e26452015-06-02 09:56:29 -07004628 public List<String> getPermittedAccessibilityServices(@NonNull ComponentName admin) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01004629 throwIfParentInstance("getPermittedAccessibilityServices");
Kenny Guyfa80a4f2014-08-20 19:40:59 +01004630 if (mService != null) {
4631 try {
4632 return mService.getPermittedAccessibilityServices(admin);
4633 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07004634 throw e.rethrowFromSystemServer();
Kenny Guyfa80a4f2014-08-20 19:40:59 +01004635 }
4636 }
4637 return null;
4638 }
4639
4640 /**
Sudheer Shanka56925862016-01-28 19:43:59 +00004641 * Called by the system to check if a specific accessibility service is disabled by admin.
4642 *
4643 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
4644 * @param packageName Accessibility service package name that needs to be checked.
4645 * @param userHandle user id the admin is running as.
4646 * @return true if the accessibility service is permitted, otherwise false.
4647 *
4648 * @hide
4649 */
4650 public boolean isAccessibilityServicePermittedByAdmin(@NonNull ComponentName admin,
4651 @NonNull String packageName, int userHandle) {
4652 if (mService != null) {
4653 try {
4654 return mService.isAccessibilityServicePermittedByAdmin(admin, packageName,
4655 userHandle);
4656 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07004657 throw e.rethrowFromSystemServer();
Sudheer Shanka56925862016-01-28 19:43:59 +00004658 }
4659 }
4660 return false;
4661 }
4662
4663 /**
Kenny Guyfa80a4f2014-08-20 19:40:59 +01004664 * Returns the list of accessibility services permitted by the device or profiles
4665 * owners of this user.
4666 *
4667 * <p>Null means all accessibility services are allowed, if a non-null list is returned
4668 * it will contain the intersection of the permitted lists for any device or profile
4669 * owners that apply to this user. It will also include any system accessibility services.
4670 *
4671 * @param userId which user to check for.
4672 * @return List of accessiblity service package names.
4673 * @hide
4674 */
4675 @SystemApi
4676 public List<String> getPermittedAccessibilityServices(int userId) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01004677 throwIfParentInstance("getPermittedAccessibilityServices");
Kenny Guyfa80a4f2014-08-20 19:40:59 +01004678 if (mService != null) {
4679 try {
4680 return mService.getPermittedAccessibilityServicesForUser(userId);
4681 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07004682 throw e.rethrowFromSystemServer();
Kenny Guyfa80a4f2014-08-20 19:40:59 +01004683 }
4684 }
4685 return null;
4686 }
4687
4688 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004689 * Called by a profile or device owner to set the permitted input methods services. When set by
4690 * a device owner or profile owner the restriction applies to all profiles of the user the
4691 * device owner or profile owner is an admin for. By default the user can use any input method.
4692 * When zero or more packages have been added, input method that are not in the list and not
4693 * part of the system can not be enabled by the user. This method will fail if it is called for
4694 * a admin that is not for the foreground user or a profile of the foreground user.
4695 * <p>
4696 * Calling with a null value for the list disables the restriction so that all input methods can
4697 * be used, calling with an empty list disables all but the system's own input methods.
4698 * <p>
4699 * System input methods are always available to the user this method can't modify this.
Kenny Guyfa80a4f2014-08-20 19:40:59 +01004700 *
4701 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
4702 * @param packageNames List of input method package names.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004703 * @return true if setting the restriction succeeded. It will fail if there are one or more
4704 * non-system input methods currently enabled that are not in the packageNames list.
4705 * @throws SecurityException if {@code admin} is not a device or profile owner.
Kenny Guyfa80a4f2014-08-20 19:40:59 +01004706 */
Robin Lee25e26452015-06-02 09:56:29 -07004707 public boolean setPermittedInputMethods(@NonNull ComponentName admin, List<String> packageNames) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01004708 throwIfParentInstance("setPermittedInputMethods");
Kenny Guyfa80a4f2014-08-20 19:40:59 +01004709 if (mService != null) {
4710 try {
4711 return mService.setPermittedInputMethods(admin, packageNames);
4712 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07004713 throw e.rethrowFromSystemServer();
Kenny Guyfa80a4f2014-08-20 19:40:59 +01004714 }
4715 }
4716 return false;
4717 }
4718
4719
4720 /**
4721 * Returns the list of permitted input methods set by this device or profile owner.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004722 * <p>
4723 * An empty list means no input methods except system input methods are allowed. Null means all
4724 * input methods are allowed.
Kenny Guyfa80a4f2014-08-20 19:40:59 +01004725 *
4726 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
4727 * @return List of input method package names.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004728 * @throws SecurityException if {@code admin} is not a device or profile owner.
Kenny Guyfa80a4f2014-08-20 19:40:59 +01004729 */
Robin Lee25e26452015-06-02 09:56:29 -07004730 public List<String> getPermittedInputMethods(@NonNull ComponentName admin) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01004731 throwIfParentInstance("getPermittedInputMethods");
Kenny Guyfa80a4f2014-08-20 19:40:59 +01004732 if (mService != null) {
4733 try {
4734 return mService.getPermittedInputMethods(admin);
4735 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07004736 throw e.rethrowFromSystemServer();
Kenny Guyfa80a4f2014-08-20 19:40:59 +01004737 }
4738 }
4739 return null;
4740 }
4741
4742 /**
Sudheer Shanka56925862016-01-28 19:43:59 +00004743 * Called by the system to check if a specific input method is disabled by admin.
4744 *
4745 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
4746 * @param packageName Input method package name that needs to be checked.
4747 * @param userHandle user id the admin is running as.
4748 * @return true if the input method is permitted, otherwise false.
4749 *
4750 * @hide
4751 */
4752 public boolean isInputMethodPermittedByAdmin(@NonNull ComponentName admin,
4753 @NonNull String packageName, int userHandle) {
4754 if (mService != null) {
4755 try {
4756 return mService.isInputMethodPermittedByAdmin(admin, packageName, userHandle);
4757 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07004758 throw e.rethrowFromSystemServer();
Sudheer Shanka56925862016-01-28 19:43:59 +00004759 }
4760 }
4761 return false;
4762 }
4763
4764 /**
Kenny Guyfa80a4f2014-08-20 19:40:59 +01004765 * Returns the list of input methods permitted by the device or profiles
Makoto Onuki32b30572015-12-11 14:29:51 -08004766 * owners of the current user. (*Not* calling user, due to a limitation in InputMethodManager.)
Kenny Guyfa80a4f2014-08-20 19:40:59 +01004767 *
4768 * <p>Null means all input methods are allowed, if a non-null list is returned
4769 * it will contain the intersection of the permitted lists for any device or profile
4770 * owners that apply to this user. It will also include any system input methods.
4771 *
4772 * @return List of input method package names.
4773 * @hide
4774 */
4775 @SystemApi
4776 public List<String> getPermittedInputMethodsForCurrentUser() {
Benjamin Franzbc33c822016-04-15 08:57:52 +01004777 throwIfParentInstance("getPermittedInputMethodsForCurrentUser");
Kenny Guyfa80a4f2014-08-20 19:40:59 +01004778 if (mService != null) {
4779 try {
4780 return mService.getPermittedInputMethodsForCurrentUser();
4781 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07004782 throw e.rethrowFromSystemServer();
Kenny Guyfa80a4f2014-08-20 19:40:59 +01004783 }
4784 }
4785 return null;
4786 }
4787
4788 /**
Fyodor Kupolovcb6fd802015-11-05 14:27:06 -08004789 * Called by a device owner to get the list of apps to keep around as APKs even if no user has
4790 * currently installed it.
4791 *
4792 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
4793 *
4794 * @return List of package names to keep cached.
4795 * @hide
4796 */
4797 public List<String> getKeepUninstalledPackages(@NonNull ComponentName admin) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01004798 throwIfParentInstance("getKeepUninstalledPackages");
Fyodor Kupolovcb6fd802015-11-05 14:27:06 -08004799 if (mService != null) {
4800 try {
4801 return mService.getKeepUninstalledPackages(admin);
4802 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07004803 throw e.rethrowFromSystemServer();
Fyodor Kupolovcb6fd802015-11-05 14:27:06 -08004804 }
4805 }
4806 return null;
4807 }
4808
4809 /**
4810 * Called by a device owner to set a list of apps to keep around as APKs even if no user has
4811 * currently installed it.
4812 *
4813 * <p>Please note that setting this policy does not imply that specified apps will be
4814 * automatically pre-cached.</p>
4815 *
4816 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
4817 * @param packageNames List of package names to keep cached.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004818 * @throws SecurityException if {@code admin} is not a device owner.
Fyodor Kupolovcb6fd802015-11-05 14:27:06 -08004819 * @hide
4820 */
4821 public void setKeepUninstalledPackages(@NonNull ComponentName admin,
4822 @NonNull List<String> packageNames) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01004823 throwIfParentInstance("setKeepUninstalledPackages");
Fyodor Kupolovcb6fd802015-11-05 14:27:06 -08004824 if (mService != null) {
4825 try {
4826 mService.setKeepUninstalledPackages(admin, packageNames);
4827 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07004828 throw e.rethrowFromSystemServer();
Fyodor Kupolovcb6fd802015-11-05 14:27:06 -08004829 }
4830 }
4831 }
4832
4833 /**
Julia Reynolds1e958392014-05-16 14:25:21 -04004834 * Called by a device owner to create a user with the specified name. The UserHandle returned
4835 * by this method should not be persisted as user handles are recycled as users are removed and
4836 * created. If you need to persist an identifier for this user, use
4837 * {@link UserManager#getSerialNumberForUser}.
4838 *
4839 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
4840 * @param name the user's name
4841 * @see UserHandle
Robin Lee25e26452015-06-02 09:56:29 -07004842 * @return the {@link android.os.UserHandle} object for the created user, or {@code null} if the
4843 * user could not be created.
Kenny Guy14f48e52015-06-29 15:12:36 +01004844 *
Dianne Hackborn0e3de6c2015-07-29 15:20:21 -07004845 * @deprecated From {@link android.os.Build.VERSION_CODES#M}
phweiss27ee3342016-02-08 16:40:45 +01004846 * @removed From {@link android.os.Build.VERSION_CODES#N}
Julia Reynolds1e958392014-05-16 14:25:21 -04004847 */
Kenny Guy14f48e52015-06-29 15:12:36 +01004848 @Deprecated
Robin Lee25e26452015-06-02 09:56:29 -07004849 public UserHandle createUser(@NonNull ComponentName admin, String name) {
Julia Reynolds1e958392014-05-16 14:25:21 -04004850 return null;
4851 }
4852
4853 /**
Jason Monk03978a42014-06-10 15:05:30 -04004854 * Called by a device owner to create a user with the specified name. The UserHandle returned
4855 * by this method should not be persisted as user handles are recycled as users are removed and
4856 * created. If you need to persist an identifier for this user, use
4857 * {@link UserManager#getSerialNumberForUser}. The new user will be started in the background
4858 * immediately.
4859 *
4860 * <p> profileOwnerComponent is the {@link DeviceAdminReceiver} to be the profile owner as well
4861 * as registered as an active admin on the new user. The profile owner package will be
4862 * installed on the new user if it already is installed on the device.
4863 *
4864 * <p>If the optionalInitializeData is not null, then the extras will be passed to the
4865 * profileOwnerComponent when onEnable is called.
4866 *
4867 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
4868 * @param name the user's name
4869 * @param ownerName the human readable name of the organisation associated with this DPM.
4870 * @param profileOwnerComponent The {@link DeviceAdminReceiver} that will be an active admin on
4871 * the user.
4872 * @param adminExtras Extras that will be passed to onEnable of the admin receiver
4873 * on the new user.
4874 * @see UserHandle
Robin Lee25e26452015-06-02 09:56:29 -07004875 * @return the {@link android.os.UserHandle} object for the created user, or {@code null} if the
4876 * user could not be created.
Kenny Guy14f48e52015-06-29 15:12:36 +01004877 *
Dianne Hackborn0e3de6c2015-07-29 15:20:21 -07004878 * @deprecated From {@link android.os.Build.VERSION_CODES#M}
phweiss27ee3342016-02-08 16:40:45 +01004879 * @removed From {@link android.os.Build.VERSION_CODES#N}
Jason Monk03978a42014-06-10 15:05:30 -04004880 */
Kenny Guy14f48e52015-06-29 15:12:36 +01004881 @Deprecated
Robin Lee25e26452015-06-02 09:56:29 -07004882 public UserHandle createAndInitializeUser(@NonNull ComponentName admin, String name,
4883 String ownerName, @NonNull ComponentName profileOwnerComponent, Bundle adminExtras) {
Jason Monk03978a42014-06-10 15:05:30 -04004884 return null;
4885 }
4886
4887 /**
phweissa92e1212016-01-25 17:14:10 +01004888 * Flag used by {@link #createAndManageUser} to skip setup wizard after creating a new user.
phweiss343fb332016-01-25 14:48:59 +01004889 */
4890 public static final int SKIP_SETUP_WIZARD = 0x0001;
4891
4892 /**
Lenka Trochtovac8202c82016-01-26 15:11:09 +01004893 * Flag used by {@link #createAndManageUser} to specify that the user should be created
4894 * ephemeral.
4895 * @hide
4896 */
4897 public static final int MAKE_USER_EPHEMERAL = 0x0002;
4898
4899 /**
phweissa92e1212016-01-25 17:14:10 +01004900 * Called by a device owner to create a user with the specified name and a given component of
4901 * the calling package as profile owner. The UserHandle returned by this method should not be
4902 * persisted as user handles are recycled as users are removed and created. If you need to
4903 * persist an identifier for this user, use {@link UserManager#getSerialNumberForUser}. The new
4904 * user will not be started in the background.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004905 * <p>
4906 * admin is the {@link DeviceAdminReceiver} which is the device owner. profileOwner is also a
4907 * DeviceAdminReceiver in the same package as admin, and will become the profile owner and will
4908 * be registered as an active admin on the new user. The profile owner package will be installed
4909 * on the new user.
4910 * <p>
4911 * If the adminExtras are not null, they will be stored on the device until the user is started
4912 * for the first time. Then the extras will be passed to the admin when onEnable is called.
phweiss343fb332016-01-25 14:48:59 +01004913 *
4914 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
4915 * @param name The user's name.
phweissa92e1212016-01-25 17:14:10 +01004916 * @param profileOwner Which {@link DeviceAdminReceiver} will be profile owner. Has to be in the
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004917 * same package as admin, otherwise no user is created and an
4918 * IllegalArgumentException is thrown.
phweiss343fb332016-01-25 14:48:59 +01004919 * @param adminExtras Extras that will be passed to onEnable of the admin receiver on the new
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004920 * user.
phweissa92e1212016-01-25 17:14:10 +01004921 * @param flags {@link #SKIP_SETUP_WIZARD} is supported.
phweiss343fb332016-01-25 14:48:59 +01004922 * @see UserHandle
4923 * @return the {@link android.os.UserHandle} object for the created user, or {@code null} if the
4924 * user could not be created.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004925 * @throws SecurityException if {@code admin} is not a device owner.
phweiss343fb332016-01-25 14:48:59 +01004926 */
4927 public UserHandle createAndManageUser(@NonNull ComponentName admin, @NonNull String name,
phweissa92e1212016-01-25 17:14:10 +01004928 @NonNull ComponentName profileOwner, @Nullable PersistableBundle adminExtras,
4929 int flags) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01004930 throwIfParentInstance("createAndManageUser");
phweiss343fb332016-01-25 14:48:59 +01004931 try {
phweissa92e1212016-01-25 17:14:10 +01004932 return mService.createAndManageUser(admin, name, profileOwner, adminExtras, flags);
phweiss343fb332016-01-25 14:48:59 +01004933 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07004934 throw re.rethrowFromSystemServer();
phweiss343fb332016-01-25 14:48:59 +01004935 }
phweiss343fb332016-01-25 14:48:59 +01004936 }
4937
4938 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004939 * Called by a device owner to remove a user and all associated data. The primary user can not
4940 * be removed.
Julia Reynolds1e958392014-05-16 14:25:21 -04004941 *
4942 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
4943 * @param userHandle the user to remove.
4944 * @return {@code true} if the user was removed, {@code false} otherwise.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004945 * @throws SecurityException if {@code admin} is not a device owner.
Julia Reynolds1e958392014-05-16 14:25:21 -04004946 */
Robin Lee25e26452015-06-02 09:56:29 -07004947 public boolean removeUser(@NonNull ComponentName admin, UserHandle userHandle) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01004948 throwIfParentInstance("removeUser");
Julia Reynolds1e958392014-05-16 14:25:21 -04004949 try {
4950 return mService.removeUser(admin, userHandle);
4951 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07004952 throw re.rethrowFromSystemServer();
Julia Reynolds1e958392014-05-16 14:25:21 -04004953 }
4954 }
4955
4956 /**
Jason Monk582d9112014-07-09 19:57:08 -04004957 * Called by a device owner to switch the specified user to the foreground.
4958 *
4959 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
4960 * @param userHandle the user to switch to; null will switch to primary.
4961 * @return {@code true} if the switch was successful, {@code false} otherwise.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004962 * @throws SecurityException if {@code admin} is not a device owner.
Jason Monk582d9112014-07-09 19:57:08 -04004963 * @see Intent#ACTION_USER_FOREGROUND
4964 */
Robin Lee25e26452015-06-02 09:56:29 -07004965 public boolean switchUser(@NonNull ComponentName admin, @Nullable UserHandle userHandle) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01004966 throwIfParentInstance("switchUser");
Jason Monk582d9112014-07-09 19:57:08 -04004967 try {
4968 return mService.switchUser(admin, userHandle);
4969 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07004970 throw re.rethrowFromSystemServer();
Jason Monk582d9112014-07-09 19:57:08 -04004971 }
4972 }
4973
4974 /**
Esteban Talaverabf60f722015-12-10 16:26:44 +00004975 * Retrieves the application restrictions for a given target application running in the calling
4976 * user.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004977 * <p>
4978 * The caller must be a profile or device owner on that user, or the package allowed to manage
4979 * application restrictions via {@link #setApplicationRestrictionsManagingPackage}; otherwise a
4980 * security exception will be thrown.
Robin Lee66e5d962014-04-09 16:44:21 +01004981 *
Esteban Talaverabf60f722015-12-10 16:26:44 +00004982 * @param admin Which {@link DeviceAdminReceiver} this request is associated with, or
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004983 * {@code null} if called by the application restrictions managing package.
Robin Lee66e5d962014-04-09 16:44:21 +01004984 * @param packageName The name of the package to fetch restricted settings of.
4985 * @return {@link Bundle} of settings corresponding to what was set last time
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004986 * {@link DevicePolicyManager#setApplicationRestrictions} was called, or an empty
4987 * {@link Bundle} if no restrictions have been set.
4988 * @throws SecurityException if {@code admin} is not a device or profile owner.
Esteban Talaverabf60f722015-12-10 16:26:44 +00004989 * @see {@link #setApplicationRestrictionsManagingPackage}
Robin Lee66e5d962014-04-09 16:44:21 +01004990 */
Esteban Talaverabf60f722015-12-10 16:26:44 +00004991 public Bundle getApplicationRestrictions(@Nullable ComponentName admin, String packageName) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01004992 throwIfParentInstance("getApplicationRestrictions");
Robin Lee66e5d962014-04-09 16:44:21 +01004993 if (mService != null) {
4994 try {
4995 return mService.getApplicationRestrictions(admin, packageName);
4996 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07004997 throw e.rethrowFromSystemServer();
Robin Lee66e5d962014-04-09 16:44:21 +01004998 }
4999 }
5000 return null;
5001 }
Amith Yamasanibe465322014-04-24 13:45:17 -07005002
5003 /**
Julia Reynolds20118f12015-02-11 12:34:08 -05005004 * Called by a profile or device owner to set a user restriction specified by the key.
Amith Yamasanibe465322014-04-24 13:45:17 -07005005 * <p>
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005006 * The calling device admin must be a profile or device owner; if it is not, a security
5007 * exception will be thrown.
Jim Millerdf2258b2014-04-27 20:10:26 -07005008 *
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005009 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
5010 * @param key The key of the restriction. See the constants in {@link android.os.UserManager}
5011 * for the list of keys.
5012 * @throws SecurityException if {@code admin} is not a device or profile owner.
Amith Yamasanibe465322014-04-24 13:45:17 -07005013 */
Robin Lee25e26452015-06-02 09:56:29 -07005014 public void addUserRestriction(@NonNull ComponentName admin, String key) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01005015 throwIfParentInstance("addUserRestriction");
Amith Yamasanibe465322014-04-24 13:45:17 -07005016 if (mService != null) {
5017 try {
5018 mService.setUserRestriction(admin, key, true);
5019 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07005020 throw e.rethrowFromSystemServer();
Amith Yamasanibe465322014-04-24 13:45:17 -07005021 }
5022 }
5023 }
5024
5025 /**
Julia Reynolds20118f12015-02-11 12:34:08 -05005026 * Called by a profile or device owner to clear a user restriction specified by the key.
Amith Yamasanibe465322014-04-24 13:45:17 -07005027 * <p>
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005028 * The calling device admin must be a profile or device owner; if it is not, a security
5029 * exception will be thrown.
Jim Millerdf2258b2014-04-27 20:10:26 -07005030 *
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005031 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
5032 * @param key The key of the restriction. See the constants in {@link android.os.UserManager}
5033 * for the list of keys.
5034 * @throws SecurityException if {@code admin} is not a device or profile owner.
Amith Yamasanibe465322014-04-24 13:45:17 -07005035 */
Robin Lee25e26452015-06-02 09:56:29 -07005036 public void clearUserRestriction(@NonNull ComponentName admin, String key) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01005037 throwIfParentInstance("clearUserRestriction");
Amith Yamasanibe465322014-04-24 13:45:17 -07005038 if (mService != null) {
5039 try {
5040 mService.setUserRestriction(admin, key, false);
5041 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07005042 throw e.rethrowFromSystemServer();
Amith Yamasanibe465322014-04-24 13:45:17 -07005043 }
5044 }
5045 }
Adam Connors010cfd42014-04-16 12:48:13 +01005046
5047 /**
Makoto Onuki3a3092f2015-10-30 11:07:51 -07005048 * Called by a profile or device owner to get user restrictions set with
5049 * {@link #addUserRestriction(ComponentName, String)}.
5050 * <p>
5051 * The target user may have more restrictions set by the system or other device owner / profile
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005052 * owner. To get all the user restrictions currently set, use
Makoto Onuki3a3092f2015-10-30 11:07:51 -07005053 * {@link UserManager#getUserRestrictions()}.
5054 *
5055 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005056 * @throws SecurityException if {@code admin} is not a device or profile owner.
Makoto Onuki3a3092f2015-10-30 11:07:51 -07005057 */
5058 public Bundle getUserRestrictions(@NonNull ComponentName admin) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01005059 throwIfParentInstance("getUserRestrictions");
Makoto Onuki3a3092f2015-10-30 11:07:51 -07005060 Bundle ret = null;
5061 if (mService != null) {
5062 try {
Sudheer Shanka549b9692016-03-30 17:12:07 -07005063 ret = mService.getUserRestrictions(admin);
5064 } catch (RemoteException e) {
5065 throw e.rethrowFromSystemServer();
5066 }
5067 }
5068 return ret == null ? new Bundle() : ret;
5069 }
5070
5071 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005072 * Called by profile or device owners to hide or unhide packages. When a package is hidden it is
5073 * unavailable for use, but the data and actual package file remain.
Julia Reynolds966881e2014-05-14 12:23:08 -04005074 *
5075 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
Amith Yamasanie5bcff62014-07-19 15:44:09 -07005076 * @param packageName The name of the package to hide or unhide.
5077 * @param hidden {@code true} if the package should be hidden, {@code false} if it should be
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005078 * unhidden.
Amith Yamasanie5bcff62014-07-19 15:44:09 -07005079 * @return boolean Whether the hidden setting of the package was successfully updated.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005080 * @throws SecurityException if {@code admin} is not a device or profile owner.
Julia Reynolds966881e2014-05-14 12:23:08 -04005081 */
Robin Lee25e26452015-06-02 09:56:29 -07005082 public boolean setApplicationHidden(@NonNull ComponentName admin, String packageName,
Amith Yamasanie5bcff62014-07-19 15:44:09 -07005083 boolean hidden) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01005084 throwIfParentInstance("setApplicationHidden");
Julia Reynolds966881e2014-05-14 12:23:08 -04005085 if (mService != null) {
5086 try {
Amith Yamasanie5bcff62014-07-19 15:44:09 -07005087 return mService.setApplicationHidden(admin, packageName, hidden);
Julia Reynolds966881e2014-05-14 12:23:08 -04005088 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07005089 throw e.rethrowFromSystemServer();
Julia Reynolds966881e2014-05-14 12:23:08 -04005090 }
5091 }
5092 return false;
5093 }
5094
5095 /**
Julia Reynolds20118f12015-02-11 12:34:08 -05005096 * Called by profile or device owners to determine if a package is hidden.
Julia Reynolds966881e2014-05-14 12:23:08 -04005097 *
5098 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
Amith Yamasanie5bcff62014-07-19 15:44:09 -07005099 * @param packageName The name of the package to retrieve the hidden status of.
5100 * @return boolean {@code true} if the package is hidden, {@code false} otherwise.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005101 * @throws SecurityException if {@code admin} is not a device or profile owner.
Julia Reynolds966881e2014-05-14 12:23:08 -04005102 */
Robin Lee25e26452015-06-02 09:56:29 -07005103 public boolean isApplicationHidden(@NonNull ComponentName admin, String packageName) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01005104 throwIfParentInstance("isApplicationHidden");
Julia Reynolds966881e2014-05-14 12:23:08 -04005105 if (mService != null) {
5106 try {
Amith Yamasanie5bcff62014-07-19 15:44:09 -07005107 return mService.isApplicationHidden(admin, packageName);
Julia Reynolds966881e2014-05-14 12:23:08 -04005108 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07005109 throw e.rethrowFromSystemServer();
Julia Reynolds966881e2014-05-14 12:23:08 -04005110 }
5111 }
5112 return false;
5113 }
5114
5115 /**
Julia Reynolds20118f12015-02-11 12:34:08 -05005116 * Called by profile or device owners to re-enable a system app that was disabled by default
Amith Yamasanic34dc7c2014-09-18 09:42:42 -07005117 * when the user was initialized.
Adam Connors655be2a2014-07-14 09:01:25 +00005118 *
5119 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
Makoto Onuki32b30572015-12-11 14:29:51 -08005120 * @param packageName The package to be re-enabled in the calling profile.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005121 * @throws SecurityException if {@code admin} is not a device or profile owner.
Adam Connors655be2a2014-07-14 09:01:25 +00005122 */
Robin Lee25e26452015-06-02 09:56:29 -07005123 public void enableSystemApp(@NonNull ComponentName admin, String packageName) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01005124 throwIfParentInstance("enableSystemApp");
Adam Connors655be2a2014-07-14 09:01:25 +00005125 if (mService != null) {
5126 try {
5127 mService.enableSystemApp(admin, packageName);
5128 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07005129 throw e.rethrowFromSystemServer();
Adam Connors655be2a2014-07-14 09:01:25 +00005130 }
5131 }
5132 }
5133
5134 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005135 * Called by profile or device owners to re-enable system apps by intent that were disabled by
5136 * default when the user was initialized.
Adam Connors655be2a2014-07-14 09:01:25 +00005137 *
5138 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
5139 * @param intent An intent matching the app(s) to be installed. All apps that resolve for this
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005140 * intent will be re-enabled in the calling profile.
Adam Connors655be2a2014-07-14 09:01:25 +00005141 * @return int The number of activities that matched the intent and were installed.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005142 * @throws SecurityException if {@code admin} is not a device or profile owner.
Adam Connors655be2a2014-07-14 09:01:25 +00005143 */
Robin Lee25e26452015-06-02 09:56:29 -07005144 public int enableSystemApp(@NonNull ComponentName admin, Intent intent) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01005145 throwIfParentInstance("enableSystemApp");
Adam Connors655be2a2014-07-14 09:01:25 +00005146 if (mService != null) {
5147 try {
5148 return mService.enableSystemAppWithIntent(admin, intent);
5149 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07005150 throw e.rethrowFromSystemServer();
Adam Connors655be2a2014-07-14 09:01:25 +00005151 }
5152 }
5153 return 0;
5154 }
5155
5156 /**
Sander Alewijnse112e0532014-10-29 13:28:49 +00005157 * Called by a device owner or profile owner to disable account management for a specific type
5158 * of account.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005159 * <p>
5160 * The calling device admin must be a device owner or profile owner. If it is not, a security
5161 * exception will be thrown.
5162 * <p>
5163 * When account management is disabled for an account type, adding or removing an account of
5164 * that type will not be possible.
5165 * <p>
5166 * From {@link android.os.Build.VERSION_CODES#N} the profile or device owner can still use
Benjamin Franzb6c0ce42015-11-05 10:06:51 +00005167 * {@link android.accounts.AccountManager} APIs to add or remove accounts when account
5168 * management for a specific type is disabled.
5169 *
Sander Alewijnse650c3342014-05-08 18:00:50 +01005170 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
5171 * @param accountType For which account management is disabled or enabled.
5172 * @param disabled The boolean indicating that account management will be disabled (true) or
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005173 * enabled (false).
5174 * @throws SecurityException if {@code admin} is not a device or profile owner.
Sander Alewijnse650c3342014-05-08 18:00:50 +01005175 */
Robin Lee25e26452015-06-02 09:56:29 -07005176 public void setAccountManagementDisabled(@NonNull ComponentName admin, String accountType,
Sander Alewijnse650c3342014-05-08 18:00:50 +01005177 boolean disabled) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01005178 throwIfParentInstance("setAccountManagementDisabled");
Sander Alewijnse650c3342014-05-08 18:00:50 +01005179 if (mService != null) {
5180 try {
5181 mService.setAccountManagementDisabled(admin, accountType, disabled);
5182 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07005183 throw e.rethrowFromSystemServer();
Sander Alewijnse650c3342014-05-08 18:00:50 +01005184 }
5185 }
5186 }
5187
5188 /**
Sander Alewijnse5c02db62014-05-07 10:46:57 +01005189 * Gets the array of accounts for which account management is disabled by the profile owner.
5190 *
5191 * <p> Account management can be disabled/enabled by calling
5192 * {@link #setAccountManagementDisabled}.
5193 *
5194 * @return a list of account types for which account management has been disabled.
5195 *
5196 * @see #setAccountManagementDisabled
5197 */
5198 public String[] getAccountTypesWithManagementDisabled() {
Benjamin Franzbc33c822016-04-15 08:57:52 +01005199 throwIfParentInstance("getAccountTypesWithManagementDisabled");
Makoto Onukicc4bbeb2015-09-17 10:28:24 -07005200 return getAccountTypesWithManagementDisabledAsUser(myUserId());
Alexandra Gherghina999d3942014-07-03 11:40:08 +01005201 }
5202
5203 /**
5204 * @see #getAccountTypesWithManagementDisabled()
5205 * @hide
5206 */
5207 public String[] getAccountTypesWithManagementDisabledAsUser(int userId) {
Sander Alewijnse5c02db62014-05-07 10:46:57 +01005208 if (mService != null) {
5209 try {
Alexandra Gherghina999d3942014-07-03 11:40:08 +01005210 return mService.getAccountTypesWithManagementDisabledAsUser(userId);
Sander Alewijnse5c02db62014-05-07 10:46:57 +01005211 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07005212 throw e.rethrowFromSystemServer();
Sander Alewijnse5c02db62014-05-07 10:46:57 +01005213 }
5214 }
5215
5216 return null;
5217 }
justinzhang511e0d82014-03-24 16:09:24 -04005218
5219 /**
Jason Monkd7b86212014-06-16 13:15:38 -04005220 * Sets which packages may enter lock task mode.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005221 * <p>
5222 * Any packages that shares uid with an allowed package will also be allowed to activate lock
5223 * task. From {@link android.os.Build.VERSION_CODES#M} removing packages from the lock task
5224 * package list results in locked tasks belonging to those packages to be finished. This
5225 * function can only be called by the device owner.
Jason Monkd7b86212014-06-16 13:15:38 -04005226 *
Jason Monkd7b86212014-06-16 13:15:38 -04005227 * @param packages The list of packages allowed to enter lock task mode
Jason Monk48aacba2014-08-13 16:29:08 -04005228 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005229 * @throws SecurityException if {@code admin} is not a device owner.
Jason Monkd7b86212014-06-16 13:15:38 -04005230 * @see Activity#startLockTask()
Benjamin Franz6cdb27e2015-02-26 12:26:53 +00005231 * @see DeviceAdminReceiver#onLockTaskModeEntering(Context, Intent, String)
5232 * @see DeviceAdminReceiver#onLockTaskModeExiting(Context, Intent)
Jason Monk1c7c3192014-06-26 12:52:18 -04005233 * @see UserManager#DISALLOW_CREATE_WINDOWS
justinzhang511e0d82014-03-24 16:09:24 -04005234 */
Robin Lee25e26452015-06-02 09:56:29 -07005235 public void setLockTaskPackages(@NonNull ComponentName admin, String[] packages)
Jason Monk48aacba2014-08-13 16:29:08 -04005236 throws SecurityException {
Benjamin Franzbc33c822016-04-15 08:57:52 +01005237 throwIfParentInstance("setLockTaskPackages");
justinzhang511e0d82014-03-24 16:09:24 -04005238 if (mService != null) {
5239 try {
Jason Monk48aacba2014-08-13 16:29:08 -04005240 mService.setLockTaskPackages(admin, packages);
justinzhang511e0d82014-03-24 16:09:24 -04005241 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07005242 throw e.rethrowFromSystemServer();
justinzhang511e0d82014-03-24 16:09:24 -04005243 }
5244 }
5245 }
5246
5247 /**
Jason Monkd7b86212014-06-16 13:15:38 -04005248 * This function returns the list of packages allowed to start the lock task mode.
Jason Monk48aacba2014-08-13 16:29:08 -04005249 *
5250 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
justinzhang511e0d82014-03-24 16:09:24 -04005251 * @hide
5252 */
Robin Lee25e26452015-06-02 09:56:29 -07005253 public String[] getLockTaskPackages(@NonNull ComponentName admin) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01005254 throwIfParentInstance("getLockTaskPackages");
justinzhang511e0d82014-03-24 16:09:24 -04005255 if (mService != null) {
5256 try {
Jason Monk48aacba2014-08-13 16:29:08 -04005257 return mService.getLockTaskPackages(admin);
justinzhang511e0d82014-03-24 16:09:24 -04005258 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07005259 throw e.rethrowFromSystemServer();
justinzhang511e0d82014-03-24 16:09:24 -04005260 }
5261 }
5262 return null;
5263 }
5264
5265 /**
5266 * This function lets the caller know whether the given component is allowed to start the
5267 * lock task mode.
Jason Monkd7b86212014-06-16 13:15:38 -04005268 * @param pkg The package to check
justinzhang511e0d82014-03-24 16:09:24 -04005269 */
Jason Monkd7b86212014-06-16 13:15:38 -04005270 public boolean isLockTaskPermitted(String pkg) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01005271 throwIfParentInstance("isLockTaskPermitted");
justinzhang511e0d82014-03-24 16:09:24 -04005272 if (mService != null) {
5273 try {
Jason Monkd7b86212014-06-16 13:15:38 -04005274 return mService.isLockTaskPermitted(pkg);
justinzhang511e0d82014-03-24 16:09:24 -04005275 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07005276 throw e.rethrowFromSystemServer();
justinzhang511e0d82014-03-24 16:09:24 -04005277 }
5278 }
5279 return false;
5280 }
Julia Reynoldsda551652014-05-14 17:15:16 -04005281
5282 /**
5283 * Called by device owners to update {@link Settings.Global} settings. Validation that the value
5284 * 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 -07005285 * <p>
5286 * The settings that can be updated with this method are:
Julia Reynolds9ed66da2014-08-26 15:42:03 -04005287 * <ul>
5288 * <li>{@link Settings.Global#ADB_ENABLED}</li>
5289 * <li>{@link Settings.Global#AUTO_TIME}</li>
5290 * <li>{@link Settings.Global#AUTO_TIME_ZONE}</li>
Julia Reynolds9ed66da2014-08-26 15:42:03 -04005291 * <li>{@link Settings.Global#DATA_ROAMING}</li>
Julia Reynolds9ed66da2014-08-26 15:42:03 -04005292 * <li>{@link Settings.Global#USB_MASS_STORAGE_ENABLED}</li>
Julia Reynolds9ed66da2014-08-26 15:42:03 -04005293 * <li>{@link Settings.Global#WIFI_SLEEP_POLICY}</li>
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005294 * <li>{@link Settings.Global#STAY_ON_WHILE_PLUGGED_IN} This setting is only available from
5295 * {@link android.os.Build.VERSION_CODES#M} onwards and can only be set if
5296 * {@link #setMaximumTimeToLock} is not used to set a timeout.</li>
5297 * <li>{@link Settings.Global#WIFI_DEVICE_OWNER_CONFIGS_LOCKDOWN}</li> This setting is only
5298 * available from {@link android.os.Build.VERSION_CODES#M} onwards.</li>
Julia Reynolds9ed66da2014-08-26 15:42:03 -04005299 * </ul>
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005300 * <p>
5301 * Changing the following settings has no effect as of {@link android.os.Build.VERSION_CODES#M}:
Esteban Talavera656fa7f2015-06-29 17:41:39 +01005302 * <ul>
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005303 * <li>{@link Settings.Global#BLUETOOTH_ON}. Use
5304 * {@link android.bluetooth.BluetoothAdapter#enable()} and
5305 * {@link android.bluetooth.BluetoothAdapter#disable()} instead.</li>
Esteban Talavera656fa7f2015-06-29 17:41:39 +01005306 * <li>{@link Settings.Global#DEVELOPMENT_SETTINGS_ENABLED}</li>
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005307 * <li>{@link Settings.Global#MODE_RINGER}. Use
5308 * {@link android.media.AudioManager#setRingerMode(int)} instead.</li>
Esteban Talavera656fa7f2015-06-29 17:41:39 +01005309 * <li>{@link Settings.Global#NETWORK_PREFERENCE}</li>
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005310 * <li>{@link Settings.Global#WIFI_ON}. Use
5311 * {@link android.net.wifi.WifiManager#setWifiEnabled(boolean)} instead.</li>
Esteban Talavera656fa7f2015-06-29 17:41:39 +01005312 * </ul>
Julia Reynoldsda551652014-05-14 17:15:16 -04005313 *
5314 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
5315 * @param setting The name of the setting to update.
5316 * @param value The value to update the setting to.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005317 * @throws SecurityException if {@code admin} is not a device owner.
Julia Reynoldsda551652014-05-14 17:15:16 -04005318 */
Robin Lee25e26452015-06-02 09:56:29 -07005319 public void setGlobalSetting(@NonNull ComponentName admin, String setting, String value) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01005320 throwIfParentInstance("setGlobalSetting");
Julia Reynoldsda551652014-05-14 17:15:16 -04005321 if (mService != null) {
5322 try {
5323 mService.setGlobalSetting(admin, setting, value);
5324 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07005325 throw e.rethrowFromSystemServer();
Julia Reynoldsda551652014-05-14 17:15:16 -04005326 }
5327 }
5328 }
5329
5330 /**
5331 * Called by profile or device owners to update {@link Settings.Secure} settings. Validation
5332 * that the value of the setting is in the correct form for the setting type should be performed
5333 * by the caller.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005334 * <p>
5335 * The settings that can be updated by a profile or device owner with this method are:
Julia Reynolds9ed66da2014-08-26 15:42:03 -04005336 * <ul>
5337 * <li>{@link Settings.Secure#DEFAULT_INPUT_METHOD}</li>
Amith Yamasani52c39a12014-10-21 11:14:04 -07005338 * <li>{@link Settings.Secure#INSTALL_NON_MARKET_APPS}</li>
Julia Reynolds9ed66da2014-08-26 15:42:03 -04005339 * <li>{@link Settings.Secure#SKIP_FIRST_USE_HINTS}</li>
5340 * </ul>
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005341 * <p>
5342 * A device owner can additionally update the following settings:
Julia Reynolds82735bc2014-09-04 16:43:30 -04005343 * <ul>
5344 * <li>{@link Settings.Secure#LOCATION_MODE}</li>
5345 * </ul>
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005346 *
Julia Reynoldsda551652014-05-14 17:15:16 -04005347 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
5348 * @param setting The name of the setting to update.
5349 * @param value The value to update the setting to.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005350 * @throws SecurityException if {@code admin} is not a device or profile owner.
Julia Reynoldsda551652014-05-14 17:15:16 -04005351 */
Robin Lee25e26452015-06-02 09:56:29 -07005352 public void setSecureSetting(@NonNull ComponentName admin, String setting, String value) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01005353 throwIfParentInstance("setSecureSetting");
Julia Reynoldsda551652014-05-14 17:15:16 -04005354 if (mService != null) {
5355 try {
5356 mService.setSecureSetting(admin, setting, value);
5357 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07005358 throw e.rethrowFromSystemServer();
Julia Reynoldsda551652014-05-14 17:15:16 -04005359 }
5360 }
5361 }
5362
Amith Yamasanif20d6402014-05-24 15:34:37 -07005363 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005364 * Designates a specific service component as the provider for making permission requests of a
5365 * local or remote administrator of the user.
Amith Yamasanif20d6402014-05-24 15:34:37 -07005366 * <p/>
5367 * Only a profile owner can designate the restrictions provider.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005368 *
Amith Yamasanif20d6402014-05-24 15:34:37 -07005369 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
Amith Yamasanif6e2fcc2014-07-10 13:41:55 -07005370 * @param provider The component name of the service that implements
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005371 * {@link RestrictionsReceiver}. If this param is null, it removes the restrictions
5372 * provider previously assigned.
5373 * @throws SecurityException if {@code admin} is not a device or profile owner.
Amith Yamasanif20d6402014-05-24 15:34:37 -07005374 */
Robin Lee25e26452015-06-02 09:56:29 -07005375 public void setRestrictionsProvider(@NonNull ComponentName admin,
5376 @Nullable ComponentName provider) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01005377 throwIfParentInstance("setRestrictionsProvider");
Amith Yamasanif20d6402014-05-24 15:34:37 -07005378 if (mService != null) {
5379 try {
Amith Yamasanif6e2fcc2014-07-10 13:41:55 -07005380 mService.setRestrictionsProvider(admin, provider);
Amith Yamasanif20d6402014-05-24 15:34:37 -07005381 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07005382 throw re.rethrowFromSystemServer();
Amith Yamasanif20d6402014-05-24 15:34:37 -07005383 }
5384 }
5385 }
Julia Reynolds4a21b252014-06-04 11:11:43 -04005386
5387 /**
5388 * Called by profile or device owners to set the master volume mute on or off.
5389 *
5390 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
5391 * @param on {@code true} to mute master volume, {@code false} to turn mute off.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005392 * @throws SecurityException if {@code admin} is not a device or profile owner.
Julia Reynolds4a21b252014-06-04 11:11:43 -04005393 */
Robin Lee25e26452015-06-02 09:56:29 -07005394 public void setMasterVolumeMuted(@NonNull ComponentName admin, boolean on) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01005395 throwIfParentInstance("setMasterVolumeMuted");
Julia Reynolds4a21b252014-06-04 11:11:43 -04005396 if (mService != null) {
5397 try {
5398 mService.setMasterVolumeMuted(admin, on);
5399 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07005400 throw re.rethrowFromSystemServer();
Julia Reynolds4a21b252014-06-04 11:11:43 -04005401 }
5402 }
5403 }
5404
5405 /**
5406 * Called by profile or device owners to check whether the master volume mute is on or off.
5407 *
5408 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
5409 * @return {@code true} if master volume is muted, {@code false} if it's not.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005410 * @throws SecurityException if {@code admin} is not a device or profile owner.
Julia Reynolds4a21b252014-06-04 11:11:43 -04005411 */
Robin Lee25e26452015-06-02 09:56:29 -07005412 public boolean isMasterVolumeMuted(@NonNull ComponentName admin) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01005413 throwIfParentInstance("isMasterVolumeMuted");
Julia Reynolds4a21b252014-06-04 11:11:43 -04005414 if (mService != null) {
5415 try {
5416 return mService.isMasterVolumeMuted(admin);
5417 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07005418 throw re.rethrowFromSystemServer();
Julia Reynolds4a21b252014-06-04 11:11:43 -04005419 }
5420 }
5421 return false;
5422 }
Kenny Guyc13053b2014-05-29 14:17:17 +01005423
5424 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005425 * Called by profile or device owners to change whether a user can uninstall a package.
Kenny Guyc13053b2014-05-29 14:17:17 +01005426 *
5427 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
5428 * @param packageName package to change.
Esteban Talaverad5c5c132014-08-20 11:35:57 +01005429 * @param uninstallBlocked true if the user shouldn't be able to uninstall the package.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005430 * @throws SecurityException if {@code admin} is not a device or profile owner.
Kenny Guyc13053b2014-05-29 14:17:17 +01005431 */
Robin Lee25e26452015-06-02 09:56:29 -07005432 public void setUninstallBlocked(@NonNull ComponentName admin, String packageName,
Esteban Talaverad5c5c132014-08-20 11:35:57 +01005433 boolean uninstallBlocked) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01005434 throwIfParentInstance("setUninstallBlocked");
Kenny Guyc13053b2014-05-29 14:17:17 +01005435 if (mService != null) {
5436 try {
Esteban Talaverad5c5c132014-08-20 11:35:57 +01005437 mService.setUninstallBlocked(admin, packageName, uninstallBlocked);
Kenny Guyc13053b2014-05-29 14:17:17 +01005438 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07005439 throw re.rethrowFromSystemServer();
Kenny Guyc13053b2014-05-29 14:17:17 +01005440 }
5441 }
5442 }
5443
5444 /**
Makoto Onuki32b30572015-12-11 14:29:51 -08005445 * Check whether the user has been blocked by device policy from uninstalling a package.
Rubin Xua97855b2014-11-07 05:41:00 +00005446 * Requires the caller to be the profile owner if checking a specific admin's policy.
Rubin Xue1e6faa2015-03-10 10:51:59 +00005447 * <p>
5448 * <strong>Note:</strong> Starting from {@link android.os.Build.VERSION_CODES#LOLLIPOP_MR1}, the
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005449 * behavior of this API is changed such that passing {@code null} as the {@code admin} parameter
5450 * will return if any admin has blocked the uninstallation. Before L MR1, passing {@code null}
5451 * will cause a NullPointerException to be raised.
Kenny Guyc13053b2014-05-29 14:17:17 +01005452 *
Robin Lee25e26452015-06-02 09:56:29 -07005453 * @param admin The name of the admin component whose blocking policy will be checked, or
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005454 * {@code null} to check whether any admin has blocked the uninstallation.
Kenny Guyc13053b2014-05-29 14:17:17 +01005455 * @param packageName package to check.
Rubin Xua97855b2014-11-07 05:41:00 +00005456 * @return true if uninstallation is blocked.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005457 * @throws SecurityException if {@code admin} is not a device or profile owner.
Kenny Guyc13053b2014-05-29 14:17:17 +01005458 */
Robin Lee25e26452015-06-02 09:56:29 -07005459 public boolean isUninstallBlocked(@Nullable ComponentName admin, String packageName) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01005460 throwIfParentInstance("isUninstallBlocked");
Kenny Guyc13053b2014-05-29 14:17:17 +01005461 if (mService != null) {
5462 try {
Esteban Talavera729b2a62014-08-27 18:01:58 +01005463 return mService.isUninstallBlocked(admin, packageName);
Kenny Guyc13053b2014-05-29 14:17:17 +01005464 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07005465 throw re.rethrowFromSystemServer();
Kenny Guyc13053b2014-05-29 14:17:17 +01005466 }
5467 }
5468 return false;
5469 }
Svetoslav976e8bd2014-07-16 15:12:03 -07005470
5471 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005472 * Called by the profile owner of a managed profile to enable widget providers from a given
5473 * package to be available in the parent profile. As a result the user will be able to add
5474 * widgets from the white-listed package running under the profile to a widget host which runs
5475 * under the parent profile, for example the home screen. Note that a package may have zero or
5476 * more provider components, where each component provides a different widget type.
Svetoslav976e8bd2014-07-16 15:12:03 -07005477 * <p>
5478 * <strong>Note:</strong> By default no widget provider package is white-listed.
Svetoslav976e8bd2014-07-16 15:12:03 -07005479 *
5480 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
5481 * @param packageName The package from which widget providers are white-listed.
5482 * @return Whether the package was added.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005483 * @throws SecurityException if {@code admin} is not a profile owner.
Svetoslav976e8bd2014-07-16 15:12:03 -07005484 * @see #removeCrossProfileWidgetProvider(android.content.ComponentName, String)
5485 * @see #getCrossProfileWidgetProviders(android.content.ComponentName)
5486 */
Robin Lee25e26452015-06-02 09:56:29 -07005487 public boolean addCrossProfileWidgetProvider(@NonNull ComponentName admin, String packageName) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01005488 throwIfParentInstance("addCrossProfileWidgetProvider");
Svetoslav976e8bd2014-07-16 15:12:03 -07005489 if (mService != null) {
5490 try {
5491 return mService.addCrossProfileWidgetProvider(admin, packageName);
5492 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07005493 throw re.rethrowFromSystemServer();
Svetoslav976e8bd2014-07-16 15:12:03 -07005494 }
5495 }
5496 return false;
5497 }
5498
5499 /**
Amith Yamasanic34dc7c2014-09-18 09:42:42 -07005500 * Called by the profile owner of a managed profile to disable widget providers from a given
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005501 * package to be available in the parent profile. For this method to take effect the package
5502 * should have been added via
5503 * {@link #addCrossProfileWidgetProvider( android.content.ComponentName, String)}.
Svetoslav976e8bd2014-07-16 15:12:03 -07005504 * <p>
5505 * <strong>Note:</strong> By default no widget provider package is white-listed.
Svetoslav976e8bd2014-07-16 15:12:03 -07005506 *
5507 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005508 * @param packageName The package from which widget providers are no longer white-listed.
Svetoslav976e8bd2014-07-16 15:12:03 -07005509 * @return Whether the package was removed.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005510 * @throws SecurityException if {@code admin} is not a profile owner.
Svetoslav976e8bd2014-07-16 15:12:03 -07005511 * @see #addCrossProfileWidgetProvider(android.content.ComponentName, String)
5512 * @see #getCrossProfileWidgetProviders(android.content.ComponentName)
5513 */
Esteban Talavera62399912016-01-11 15:37:55 +00005514 public boolean removeCrossProfileWidgetProvider(
5515 @NonNull ComponentName admin, String packageName) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01005516 throwIfParentInstance("removeCrossProfileWidgetProvider");
Svetoslav976e8bd2014-07-16 15:12:03 -07005517 if (mService != null) {
5518 try {
5519 return mService.removeCrossProfileWidgetProvider(admin, packageName);
5520 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07005521 throw re.rethrowFromSystemServer();
Svetoslav976e8bd2014-07-16 15:12:03 -07005522 }
5523 }
5524 return false;
5525 }
5526
5527 /**
Amith Yamasanic34dc7c2014-09-18 09:42:42 -07005528 * Called by the profile owner of a managed profile to query providers from which packages are
Svetoslav976e8bd2014-07-16 15:12:03 -07005529 * available in the parent profile.
5530 *
5531 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
5532 * @return The white-listed package list.
Svetoslav976e8bd2014-07-16 15:12:03 -07005533 * @see #addCrossProfileWidgetProvider(android.content.ComponentName, String)
5534 * @see #removeCrossProfileWidgetProvider(android.content.ComponentName, String)
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005535 * @throws SecurityException if {@code admin} is not a profile owner.
Svetoslav976e8bd2014-07-16 15:12:03 -07005536 */
Robin Lee25e26452015-06-02 09:56:29 -07005537 public List<String> getCrossProfileWidgetProviders(@NonNull ComponentName admin) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01005538 throwIfParentInstance("getCrossProfileWidgetProviders");
Svetoslav976e8bd2014-07-16 15:12:03 -07005539 if (mService != null) {
5540 try {
5541 List<String> providers = mService.getCrossProfileWidgetProviders(admin);
5542 if (providers != null) {
5543 return providers;
5544 }
5545 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07005546 throw re.rethrowFromSystemServer();
Svetoslav976e8bd2014-07-16 15:12:03 -07005547 }
5548 }
5549 return Collections.emptyList();
5550 }
Julia Reynoldsfca04ca2015-02-17 13:39:12 -05005551
5552 /**
Makoto Onuki32b30572015-12-11 14:29:51 -08005553 * Called by profile or device owners to set the user's photo.
Julia Reynoldsfca04ca2015-02-17 13:39:12 -05005554 *
5555 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
5556 * @param icon the bitmap to set as the photo.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005557 * @throws SecurityException if {@code admin} is not a device or profile owner.
Julia Reynoldsfca04ca2015-02-17 13:39:12 -05005558 */
Robin Lee25e26452015-06-02 09:56:29 -07005559 public void setUserIcon(@NonNull ComponentName admin, Bitmap icon) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01005560 throwIfParentInstance("setUserIcon");
Julia Reynoldsfca04ca2015-02-17 13:39:12 -05005561 try {
5562 mService.setUserIcon(admin, icon);
5563 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07005564 throw re.rethrowFromSystemServer();
Julia Reynoldsfca04ca2015-02-17 13:39:12 -05005565 }
5566 }
Craig Lafayettedbe31a62015-04-02 13:14:39 -04005567
5568 /**
Rubin Xu5faad8e2015-04-20 17:43:48 +01005569 * Called by device owners to set a local system update policy. When a new policy is set,
5570 * {@link #ACTION_SYSTEM_UPDATE_POLICY_CHANGED} is broadcasted.
Rubin Xu8027a4f2015-03-10 17:52:37 +00005571 *
Robin Lee25e26452015-06-02 09:56:29 -07005572 * @param admin Which {@link DeviceAdminReceiver} this request is associated with. All
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005573 * components in the device owner package can set system update policies and the most
5574 * recent policy takes effect.
Robin Lee25e26452015-06-02 09:56:29 -07005575 * @param policy the new policy, or {@code null} to clear the current policy.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005576 * @throws SecurityException if {@code admin} is not a device owner.
Rubin Xu5faad8e2015-04-20 17:43:48 +01005577 * @see SystemUpdatePolicy
Rubin Xu8027a4f2015-03-10 17:52:37 +00005578 */
Robin Lee25e26452015-06-02 09:56:29 -07005579 public void setSystemUpdatePolicy(@NonNull ComponentName admin, SystemUpdatePolicy policy) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01005580 throwIfParentInstance("setSystemUpdatePolicy");
Rubin Xu8027a4f2015-03-10 17:52:37 +00005581 if (mService != null) {
5582 try {
Robin Lee25e26452015-06-02 09:56:29 -07005583 mService.setSystemUpdatePolicy(admin, policy);
Rubin Xu8027a4f2015-03-10 17:52:37 +00005584 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07005585 throw re.rethrowFromSystemServer();
Rubin Xu8027a4f2015-03-10 17:52:37 +00005586 }
5587 }
5588 }
5589
5590 /**
Rubin Xu5faad8e2015-04-20 17:43:48 +01005591 * Retrieve a local system update policy set previously by {@link #setSystemUpdatePolicy}.
Rubin Xu8027a4f2015-03-10 17:52:37 +00005592 *
Robin Lee25e26452015-06-02 09:56:29 -07005593 * @return The current policy object, or {@code null} if no policy is set.
Rubin Xu8027a4f2015-03-10 17:52:37 +00005594 */
Rubin Xu5faad8e2015-04-20 17:43:48 +01005595 public SystemUpdatePolicy getSystemUpdatePolicy() {
Benjamin Franzbc33c822016-04-15 08:57:52 +01005596 throwIfParentInstance("getSystemUpdatePolicy");
Rubin Xu8027a4f2015-03-10 17:52:37 +00005597 if (mService != null) {
5598 try {
Rubin Xud86d58c2015-05-05 16:57:37 +01005599 return mService.getSystemUpdatePolicy();
Rubin Xu8027a4f2015-03-10 17:52:37 +00005600 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07005601 throw re.rethrowFromSystemServer();
Rubin Xu8027a4f2015-03-10 17:52:37 +00005602 }
5603 }
5604 return null;
5605 }
Benjamin Franze36087e2015-04-07 16:40:34 +01005606
5607 /**
5608 * Called by a device owner to disable the keyguard altogether.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005609 * <p>
5610 * Setting the keyguard to disabled has the same effect as choosing "None" as the screen lock
5611 * type. However, this call has no effect if a password, pin or pattern is currently set. If a
5612 * password, pin or pattern is set after the keyguard was disabled, the keyguard stops being
5613 * disabled.
Benjamin Franze36087e2015-04-07 16:40:34 +01005614 *
5615 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
Benjamin Franzbece8062015-05-06 12:14:31 +01005616 * @param disabled {@code true} disables the keyguard, {@code false} reenables it.
Benjamin Franze36087e2015-04-07 16:40:34 +01005617 * @return {@code false} if attempting to disable the keyguard while a lock password was in
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005618 * place. {@code true} otherwise.
5619 * @throws SecurityException if {@code admin} is not a device owner.
Benjamin Franze36087e2015-04-07 16:40:34 +01005620 */
Robin Lee25e26452015-06-02 09:56:29 -07005621 public boolean setKeyguardDisabled(@NonNull ComponentName admin, boolean disabled) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01005622 throwIfParentInstance("setKeyguardDisabled");
Benjamin Franze36087e2015-04-07 16:40:34 +01005623 try {
Benjamin Franzbece8062015-05-06 12:14:31 +01005624 return mService.setKeyguardDisabled(admin, disabled);
Benjamin Franze36087e2015-04-07 16:40:34 +01005625 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07005626 throw re.rethrowFromSystemServer();
Benjamin Franze36087e2015-04-07 16:40:34 +01005627 }
5628 }
Benjamin Franzea2ec972015-03-16 17:18:09 +00005629
5630 /**
Benjamin Franzbece8062015-05-06 12:14:31 +01005631 * Called by device owner to disable the status bar. Disabling the status bar blocks
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005632 * notifications, quick settings and other screen overlays that allow escaping from a single use
5633 * device.
Benjamin Franzea2ec972015-03-16 17:18:09 +00005634 *
5635 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
Benjamin Franzbece8062015-05-06 12:14:31 +01005636 * @param disabled {@code true} disables the status bar, {@code false} reenables it.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005637 * @return {@code false} if attempting to disable the status bar failed. {@code true} otherwise.
5638 * @throws SecurityException if {@code admin} is not a device owner.
Benjamin Franzea2ec972015-03-16 17:18:09 +00005639 */
Robin Lee25e26452015-06-02 09:56:29 -07005640 public boolean setStatusBarDisabled(@NonNull ComponentName admin, boolean disabled) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01005641 throwIfParentInstance("setStatusBarDisabled");
Benjamin Franzea2ec972015-03-16 17:18:09 +00005642 try {
Benjamin Franzbece8062015-05-06 12:14:31 +01005643 return mService.setStatusBarDisabled(admin, disabled);
Benjamin Franzea2ec972015-03-16 17:18:09 +00005644 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07005645 throw re.rethrowFromSystemServer();
Benjamin Franzea2ec972015-03-16 17:18:09 +00005646 }
5647 }
Rubin Xudc105cc2015-04-14 23:38:01 +01005648
5649 /**
5650 * Callable by the system update service to notify device owners about pending updates.
5651 * The caller must hold {@link android.Manifest.permission#NOTIFY_PENDING_SYSTEM_UPDATE}
5652 * permission.
5653 *
5654 * @param updateReceivedTime The time as given by {@link System#currentTimeMillis()} indicating
5655 * when the current pending update was first available. -1 if no update is available.
5656 * @hide
5657 */
5658 @SystemApi
5659 public void notifyPendingSystemUpdate(long updateReceivedTime) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01005660 throwIfParentInstance("notifyPendingSystemUpdate");
Rubin Xudc105cc2015-04-14 23:38:01 +01005661 if (mService != null) {
5662 try {
5663 mService.notifyPendingSystemUpdate(updateReceivedTime);
5664 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07005665 throw re.rethrowFromSystemServer();
Rubin Xudc105cc2015-04-14 23:38:01 +01005666 }
5667 }
5668 }
Julia Reynolds13c58ba2015-04-20 16:42:54 -04005669
5670 /**
Amith Yamasanid49489b2015-04-28 14:00:26 -07005671 * Called by profile or device owners to set the default response for future runtime permission
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005672 * requests by applications. The policy can allow for normal operation which prompts the user to
5673 * grant a permission, or can allow automatic granting or denying of runtime permission requests
5674 * by an application. This also applies to new permissions declared by app updates. When a
5675 * permission is denied or granted this way, the effect is equivalent to setting the permission
5676 * grant state via {@link #setPermissionGrantState}.
5677 * <p/>
5678 * As this policy only acts on runtime permission requests, it only applies to applications
Dianne Hackborn0e3de6c2015-07-29 15:20:21 -07005679 * built with a {@code targetSdkVersion} of {@link android.os.Build.VERSION_CODES#M} or later.
Benjamin Franz45dd6662015-07-08 14:24:14 +01005680 *
Amith Yamasanid49489b2015-04-28 14:00:26 -07005681 * @param admin Which profile or device owner this request is associated with.
5682 * @param policy One of the policy constants {@link #PERMISSION_POLICY_PROMPT},
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005683 * {@link #PERMISSION_POLICY_AUTO_GRANT} and {@link #PERMISSION_POLICY_AUTO_DENY}.
5684 * @throws SecurityException if {@code admin} is not a device or profile owner.
Benjamin Franz45dd6662015-07-08 14:24:14 +01005685 * @see #setPermissionGrantState
Amith Yamasanid49489b2015-04-28 14:00:26 -07005686 */
Robin Lee25e26452015-06-02 09:56:29 -07005687 public void setPermissionPolicy(@NonNull ComponentName admin, int policy) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01005688 throwIfParentInstance("setPermissionPolicy");
Amith Yamasanid49489b2015-04-28 14:00:26 -07005689 try {
5690 mService.setPermissionPolicy(admin, policy);
5691 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07005692 throw re.rethrowFromSystemServer();
Amith Yamasanid49489b2015-04-28 14:00:26 -07005693 }
5694 }
5695
5696 /**
5697 * Returns the current runtime permission policy set by the device or profile owner. The
5698 * default is {@link #PERMISSION_POLICY_PROMPT}.
5699 * @param admin Which profile or device owner this request is associated with.
5700 * @return the current policy for future permission requests.
5701 */
Esteban Talavera28b95702015-06-24 15:23:42 +01005702 public int getPermissionPolicy(ComponentName admin) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01005703 throwIfParentInstance("getPermissionPolicy");
Amith Yamasanid49489b2015-04-28 14:00:26 -07005704 try {
5705 return mService.getPermissionPolicy(admin);
5706 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07005707 throw re.rethrowFromSystemServer();
Amith Yamasanid49489b2015-04-28 14:00:26 -07005708 }
5709 }
5710
5711 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005712 * Sets the grant state of a runtime permission for a specific application. The state can be
5713 * {@link #PERMISSION_GRANT_STATE_DEFAULT default} in which a user can manage it through the UI,
5714 * {@link #PERMISSION_GRANT_STATE_DENIED denied}, in which the permission is denied and the user
5715 * cannot manage it through the UI, and {@link #PERMISSION_GRANT_STATE_GRANTED granted} in which
5716 * the permission is granted and the user cannot manage it through the UI. This might affect all
5717 * permissions in a group that the runtime permission belongs to. This method can only be called
Svet Ganovd8ecc5a2015-05-20 10:45:43 -07005718 * by a profile or device owner.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005719 * <p/>
5720 * Setting the grant state to {@link #PERMISSION_GRANT_STATE_DEFAULT default} does not revoke
5721 * the permission. It retains the previous grant, if any.
5722 * <p/>
5723 * Permissions can be granted or revoked only for applications built with a
Dianne Hackborn0e3de6c2015-07-29 15:20:21 -07005724 * {@code targetSdkVersion} of {@link android.os.Build.VERSION_CODES#M} or later.
Amith Yamasani0bf8f7c2015-06-22 13:00:32 -07005725 *
Amith Yamasanid49489b2015-04-28 14:00:26 -07005726 * @param admin Which profile or device owner this request is associated with.
5727 * @param packageName The application to grant or revoke a permission to.
5728 * @param permission The permission to grant or revoke.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005729 * @param grantState The permission grant state which is one of
5730 * {@link #PERMISSION_GRANT_STATE_DENIED}, {@link #PERMISSION_GRANT_STATE_DEFAULT},
5731 * {@link #PERMISSION_GRANT_STATE_GRANTED},
Svet Ganovd8ecc5a2015-05-20 10:45:43 -07005732 * @return whether the permission was successfully granted or revoked.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005733 * @throws SecurityException if {@code admin} is not a device or profile owner.
Svet Ganovd8ecc5a2015-05-20 10:45:43 -07005734 * @see #PERMISSION_GRANT_STATE_DENIED
5735 * @see #PERMISSION_GRANT_STATE_DEFAULT
5736 * @see #PERMISSION_GRANT_STATE_GRANTED
Amith Yamasanid49489b2015-04-28 14:00:26 -07005737 */
Robin Lee25e26452015-06-02 09:56:29 -07005738 public boolean setPermissionGrantState(@NonNull ComponentName admin, String packageName,
Svet Ganovd8ecc5a2015-05-20 10:45:43 -07005739 String permission, int grantState) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01005740 throwIfParentInstance("setPermissionGrantState");
Amith Yamasanid49489b2015-04-28 14:00:26 -07005741 try {
Svet Ganovd8ecc5a2015-05-20 10:45:43 -07005742 return mService.setPermissionGrantState(admin, packageName, permission, grantState);
Amith Yamasanid49489b2015-04-28 14:00:26 -07005743 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07005744 throw re.rethrowFromSystemServer();
Amith Yamasanid49489b2015-04-28 14:00:26 -07005745 }
5746 }
Amith Yamasani184b3752015-05-22 13:00:51 -07005747
5748 /**
5749 * Returns the current grant state of a runtime permission for a specific application.
5750 *
5751 * @param admin Which profile or device owner this request is associated with.
5752 * @param packageName The application to check the grant state for.
5753 * @param permission The permission to check for.
5754 * @return the current grant state specified by device policy. If the profile or device owner
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005755 * has not set a grant state, the return value is
5756 * {@link #PERMISSION_GRANT_STATE_DEFAULT}. This does not indicate whether or not the
5757 * permission is currently granted for the package.
5758 * <p/>
5759 * If a grant state was set by the profile or device owner, then the return value will
5760 * be one of {@link #PERMISSION_GRANT_STATE_DENIED} or
5761 * {@link #PERMISSION_GRANT_STATE_GRANTED}, which indicates if the permission is
5762 * currently denied or granted.
5763 * @throws SecurityException if {@code admin} is not a device or profile owner.
Amith Yamasani184b3752015-05-22 13:00:51 -07005764 * @see #setPermissionGrantState(ComponentName, String, String, int)
5765 * @see PackageManager#checkPermission(String, String)
5766 */
Robin Lee25e26452015-06-02 09:56:29 -07005767 public int getPermissionGrantState(@NonNull ComponentName admin, String packageName,
Amith Yamasani184b3752015-05-22 13:00:51 -07005768 String permission) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01005769 throwIfParentInstance("getPermissionGrantState");
Amith Yamasani184b3752015-05-22 13:00:51 -07005770 try {
5771 return mService.getPermissionGrantState(admin, packageName, permission);
5772 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07005773 throw re.rethrowFromSystemServer();
Amith Yamasani184b3752015-05-22 13:00:51 -07005774 }
5775 }
Nicolas Prevot07387fe2015-10-30 17:53:30 +00005776
5777 /**
5778 * Returns if provisioning a managed profile or device is possible or not.
5779 * @param action One of {@link #ACTION_PROVISION_MANAGED_DEVICE},
5780 * {@link #ACTION_PROVISION_MANAGED_PROFILE}.
Nicolas Prevot07387fe2015-10-30 17:53:30 +00005781 * @return if provisioning a managed profile or device is possible or not.
5782 * @throws IllegalArgumentException if the supplied action is not valid.
5783 */
5784 public boolean isProvisioningAllowed(String action) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01005785 throwIfParentInstance("isProvisioningAllowed");
Nicolas Prevot07387fe2015-10-30 17:53:30 +00005786 try {
5787 return mService.isProvisioningAllowed(action);
5788 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07005789 throw re.rethrowFromSystemServer();
Nicolas Prevot07387fe2015-10-30 17:53:30 +00005790 }
5791 }
Mahaver Chopra15a46b02015-11-11 14:54:35 +00005792
5793 /**
Mahaver Chopra15a46b02015-11-11 14:54:35 +00005794 * Return if this user is a managed profile of another user. An admin can become the profile
5795 * owner of a managed profile with {@link #ACTION_PROVISION_MANAGED_PROFILE} and of a managed
Kenny Guyffa38402016-03-31 16:40:57 +01005796 * user with {@link #createAndManageUser}
Mahaver Chopra15a46b02015-11-11 14:54:35 +00005797 * @param admin Which profile owner this request is associated with.
5798 * @return if this user is a managed profile of another user.
5799 */
5800 public boolean isManagedProfile(@NonNull ComponentName admin) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01005801 throwIfParentInstance("isManagedProfile");
Mahaver Chopra15a46b02015-11-11 14:54:35 +00005802 try {
5803 return mService.isManagedProfile(admin);
5804 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07005805 throw re.rethrowFromSystemServer();
Mahaver Chopra15a46b02015-11-11 14:54:35 +00005806 }
5807 }
5808
5809 /**
5810 * @hide
5811 * Return if this user is a system-only user. An admin can manage a device from a system only
5812 * user by calling {@link #ACTION_PROVISION_MANAGED_SHAREABLE_DEVICE}.
5813 * @param admin Which device owner this request is associated with.
5814 * @return if this user is a system-only user.
5815 */
5816 public boolean isSystemOnlyUser(@NonNull ComponentName admin) {
5817 try {
5818 return mService.isSystemOnlyUser(admin);
5819 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07005820 throw re.rethrowFromSystemServer();
Mahaver Chopra15a46b02015-11-11 14:54:35 +00005821 }
5822 }
Makoto Onukia31ebbc2015-11-23 17:15:21 -08005823
5824 /**
5825 * Called by device owner to get the MAC address of the Wi-Fi device.
5826 *
Sudheer Shanka3cb4da12016-03-07 18:51:49 -08005827 * @param admin Which device owner this request is associated with.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005828 * @return the MAC address of the Wi-Fi device, or null when the information is not available.
5829 * (For example, Wi-Fi hasn't been enabled, or the device doesn't support Wi-Fi.)
5830 * <p>
5831 * The address will be in the {@code XX:XX:XX:XX:XX:XX} format.
5832 * @throws SecurityException if {@code admin} is not a device owner.
Makoto Onukia31ebbc2015-11-23 17:15:21 -08005833 */
Sudheer Shanka3cb4da12016-03-07 18:51:49 -08005834 public String getWifiMacAddress(@NonNull ComponentName admin) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01005835 throwIfParentInstance("getWifiMacAddress");
Makoto Onukia31ebbc2015-11-23 17:15:21 -08005836 try {
Sudheer Shanka3cb4da12016-03-07 18:51:49 -08005837 return mService.getWifiMacAddress(admin);
Makoto Onukia31ebbc2015-11-23 17:15:21 -08005838 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07005839 throw re.rethrowFromSystemServer();
Makoto Onukia31ebbc2015-11-23 17:15:21 -08005840 }
5841 }
Mahaver Chopra1ce53bc2015-12-14 13:35:14 +00005842
5843 /**
Mahaver Chopra1216ae52016-03-11 15:39:48 +00005844 * Called by device owner to reboot the device. If there is an ongoing call on the device,
5845 * throws an {@link IllegalStateException}.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005846 * @param admin Which device owner the request is associated with.
Mahaver Chopra1216ae52016-03-11 15:39:48 +00005847 * @throws IllegalStateException if device has an ongoing call.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005848 * @throws SecurityException if {@code admin} is not a device owner.
Mahaver Chopra1216ae52016-03-11 15:39:48 +00005849 * @see TelephonyManager#CALL_STATE_IDLE
Mahaver Chopra1ce53bc2015-12-14 13:35:14 +00005850 */
5851 public void reboot(@NonNull ComponentName admin) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01005852 throwIfParentInstance("reboot");
Mahaver Chopra1ce53bc2015-12-14 13:35:14 +00005853 try {
5854 mService.reboot(admin);
5855 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07005856 throw re.rethrowFromSystemServer();
Mahaver Chopra1ce53bc2015-12-14 13:35:14 +00005857 }
5858 }
Kenny Guy06de4e72015-12-22 12:07:39 +00005859
5860 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005861 * Called by a device admin to set the short support message. This will be displayed to the user
5862 * in settings screens where funtionality has been disabled by the admin. The message should be
5863 * limited to a short statement such as "This setting is disabled by your administrator. Contact
5864 * someone@example.com for support." If the message is longer than 200 characters it may be
5865 * truncated.
5866 * <p>
5867 * If the short support message needs to be localized, it is the responsibility of the
Benjamin Franz3e8a7092016-01-25 16:19:08 +00005868 * {@link DeviceAdminReceiver} to listen to the {@link Intent#ACTION_LOCALE_CHANGED} broadcast
5869 * and set a new version of this string accordingly.
5870 *
Kenny Guy06de4e72015-12-22 12:07:39 +00005871 * @see #setLongSupportMessage
Kenny Guy06de4e72015-12-22 12:07:39 +00005872 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005873 * @param message Short message to be displayed to the user in settings or null to clear the
5874 * existing message.
5875 * @throws SecurityException if {@code admin} is not an active administrator.
Kenny Guy06de4e72015-12-22 12:07:39 +00005876 */
5877 public void setShortSupportMessage(@NonNull ComponentName admin,
Sudheer Shanka3ccca91e2016-04-11 21:36:17 -07005878 @Nullable CharSequence message) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01005879 throwIfParentInstance("setShortSupportMessage");
Kenny Guy06de4e72015-12-22 12:07:39 +00005880 if (mService != null) {
5881 try {
5882 mService.setShortSupportMessage(admin, message);
5883 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07005884 throw e.rethrowFromSystemServer();
Kenny Guy06de4e72015-12-22 12:07:39 +00005885 }
5886 }
5887 }
5888
5889 /**
5890 * Called by a device admin to get the short support message.
5891 *
5892 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
Sudheer Shanka3ccca91e2016-04-11 21:36:17 -07005893 * @return The message set by {@link #setShortSupportMessage(ComponentName, CharSequence)} or
5894 * null if no message has been set.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005895 * @throws SecurityException if {@code admin} is not an active administrator.
Kenny Guy06de4e72015-12-22 12:07:39 +00005896 */
Sudheer Shanka3ccca91e2016-04-11 21:36:17 -07005897 public CharSequence getShortSupportMessage(@NonNull ComponentName admin) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01005898 throwIfParentInstance("getShortSupportMessage");
Kenny Guy06de4e72015-12-22 12:07:39 +00005899 if (mService != null) {
5900 try {
5901 return mService.getShortSupportMessage(admin);
5902 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07005903 throw e.rethrowFromSystemServer();
Kenny Guy06de4e72015-12-22 12:07:39 +00005904 }
5905 }
5906 return null;
5907 }
5908
5909 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005910 * Called by a device admin to set the long support message. This will be displayed to the user
5911 * in the device administators settings screen.
5912 * <p>
5913 * If the long support message needs to be localized, it is the responsibility of the
Benjamin Franz3e8a7092016-01-25 16:19:08 +00005914 * {@link DeviceAdminReceiver} to listen to the {@link Intent#ACTION_LOCALE_CHANGED} broadcast
5915 * and set a new version of this string accordingly.
5916 *
Kenny Guy06de4e72015-12-22 12:07:39 +00005917 * @see #setShortSupportMessage
Kenny Guy06de4e72015-12-22 12:07:39 +00005918 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005919 * @param message Long message to be displayed to the user in settings or null to clear the
5920 * existing message.
5921 * @throws SecurityException if {@code admin} is not an active administrator.
Kenny Guy06de4e72015-12-22 12:07:39 +00005922 */
5923 public void setLongSupportMessage(@NonNull ComponentName admin,
Sudheer Shanka3ccca91e2016-04-11 21:36:17 -07005924 @Nullable CharSequence message) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01005925 throwIfParentInstance("setLongSupportMessage");
Kenny Guy06de4e72015-12-22 12:07:39 +00005926 if (mService != null) {
5927 try {
5928 mService.setLongSupportMessage(admin, message);
5929 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07005930 throw e.rethrowFromSystemServer();
Kenny Guy06de4e72015-12-22 12:07:39 +00005931 }
5932 }
5933 }
5934
5935 /**
5936 * Called by a device admin to get the long support message.
5937 *
5938 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
Sudheer Shanka3ccca91e2016-04-11 21:36:17 -07005939 * @return The message set by {@link #setLongSupportMessage(ComponentName, CharSequence)} or
5940 * null if no message has been set.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005941 * @throws SecurityException if {@code admin} is not an active administrator.
Kenny Guy06de4e72015-12-22 12:07:39 +00005942 */
Sudheer Shanka3ccca91e2016-04-11 21:36:17 -07005943 public CharSequence getLongSupportMessage(@NonNull ComponentName admin) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01005944 throwIfParentInstance("getLongSupportMessage");
Kenny Guy06de4e72015-12-22 12:07:39 +00005945 if (mService != null) {
5946 try {
5947 return mService.getLongSupportMessage(admin);
5948 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07005949 throw e.rethrowFromSystemServer();
Kenny Guy06de4e72015-12-22 12:07:39 +00005950 }
5951 }
5952 return null;
5953 }
5954
5955 /**
5956 * Called by the system to get the short support message.
5957 *
5958 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
5959 * @param userHandle user id the admin is running as.
Sudheer Shanka3ccca91e2016-04-11 21:36:17 -07005960 * @return The message set by {@link #setShortSupportMessage(ComponentName, CharSequence)}
Kenny Guy06de4e72015-12-22 12:07:39 +00005961 *
5962 * @hide
5963 */
Sudheer Shanka3ccca91e2016-04-11 21:36:17 -07005964 public CharSequence getShortSupportMessageForUser(@NonNull ComponentName admin,
5965 int userHandle) {
Kenny Guy06de4e72015-12-22 12:07:39 +00005966 if (mService != null) {
5967 try {
5968 return mService.getShortSupportMessageForUser(admin, userHandle);
5969 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07005970 throw e.rethrowFromSystemServer();
Kenny Guy06de4e72015-12-22 12:07:39 +00005971 }
5972 }
5973 return null;
5974 }
5975
5976
5977 /**
5978 * Called by the system to get the long support message.
5979 *
5980 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
5981 * @param userHandle user id the admin is running as.
Sudheer Shanka3ccca91e2016-04-11 21:36:17 -07005982 * @return The message set by {@link #setLongSupportMessage(ComponentName, CharSequence)}
Kenny Guy06de4e72015-12-22 12:07:39 +00005983 *
5984 * @hide
5985 */
Sudheer Shanka3ccca91e2016-04-11 21:36:17 -07005986 public CharSequence getLongSupportMessageForUser(@NonNull ComponentName admin, int userHandle) {
Kenny Guy06de4e72015-12-22 12:07:39 +00005987 if (mService != null) {
5988 try {
5989 return mService.getLongSupportMessageForUser(admin, userHandle);
5990 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07005991 throw e.rethrowFromSystemServer();
Kenny Guy06de4e72015-12-22 12:07:39 +00005992 }
5993 }
5994 return null;
5995 }
Clara Bayarri3e826ef2015-12-14 17:51:22 +00005996
5997 /**
Esteban Talavera62399912016-01-11 15:37:55 +00005998 * Called by the profile owner of a managed profile to obtain a {@link DevicePolicyManager}
5999 * whose calls act on the parent profile.
Benjamin Franz66b45f02016-04-05 19:12:39 +01006000 *
6001 * <p>The following methods are supported for the parent instance, all other methods will
6002 * throw a SecurityException when called on the parent instance:
6003 * <ul>
6004 * <li>{@link #getPasswordQuality}</li>
6005 * <li>{@link #setPasswordQuality}</li>
6006 * <li>{@link #getPasswordMinimumLength}</li>
6007 * <li>{@link #setPasswordMinimumLength}</li>
6008 * <li>{@link #getPasswordMinimumUpperCase}</li>
6009 * <li>{@link #setPasswordMinimumUpperCase}</li>
6010 * <li>{@link #getPasswordMinimumLowerCase}</li>
6011 * <li>{@link #setPasswordMinimumLowerCase}</li>
6012 * <li>{@link #getPasswordMinimumLetters}</li>
6013 * <li>{@link #setPasswordMinimumLetters}</li>
6014 * <li>{@link #getPasswordMinimumNumeric}</li>
6015 * <li>{@link #setPasswordMinimumNumeric}</li>
6016 * <li>{@link #getPasswordMinimumSymbols}</li>
6017 * <li>{@link #setPasswordMinimumSymbols}</li>
6018 * <li>{@link #getPasswordMinimumNonLetter}</li>
6019 * <li>{@link #setPasswordMinimumNonLetter}</li>
6020 * <li>{@link #getPasswordHistoryLength}</li>
6021 * <li>{@link #setPasswordHistoryLength}</li>
6022 * <li>{@link #getPasswordExpirationTimeout}</li>
6023 * <li>{@link #setPasswordExpirationTimeout}</li>
6024 * <li>{@link #getPasswordExpiration}</li>
6025 * <li>{@link #isActivePasswordSufficient}</li>
6026 * <li>{@link #getCurrentFailedPasswordAttempts}</li>
6027 * <li>{@link #getMaximumFailedPasswordsForWipe}</li>
6028 * <li>{@link #setMaximumFailedPasswordsForWipe}</li>
6029 * <li>{@link #getMaximumTimeToLock}</li>
6030 * <li>{@link #setMaximumTimeToLock}</li>
6031 * <li>{@link #lockNow}</li>
6032 * <li>{@link #getKeyguardDisabledFeatures}</li>
6033 * <li>{@link #setKeyguardDisabledFeatures}</li>
6034 * <li>{@link #getTrustAgentConfiguration}</li>
6035 * <li>{@link #setTrustAgentConfiguration}</li>
6036 * </ul>
Clara Bayarri3e826ef2015-12-14 17:51:22 +00006037 *
6038 * @return a new instance of {@link DevicePolicyManager} that acts on the parent profile.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07006039 * @throws SecurityException if {@code admin} is not a profile owner.
Clara Bayarri3e826ef2015-12-14 17:51:22 +00006040 */
6041 public DevicePolicyManager getParentProfileInstance(@NonNull ComponentName admin) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01006042 throwIfParentInstance("getParentProfileInstance");
Clara Bayarri3e826ef2015-12-14 17:51:22 +00006043 try {
6044 if (!mService.isManagedProfile(admin)) {
6045 throw new SecurityException("The current user does not have a parent profile.");
6046 }
6047 return new DevicePolicyManager(mContext, true);
Rubin Xuc3cd05f2016-01-11 12:11:35 +00006048 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07006049 throw e.rethrowFromSystemServer();
Rubin Xuc3cd05f2016-01-11 12:11:35 +00006050 }
6051 }
6052
6053 /**
Michal Karpinski6235a942016-03-15 12:07:23 +00006054 * Called by device owner to control the security logging feature. Logging can only be
6055 * enabled on single user devices where the sole user is managed by the device owner.
6056 *
6057 * <p> Security logs contain various information intended for security auditing purposes.
6058 * See {@link SecurityEvent} for details.
6059 *
6060 * <p>There must be only one user on the device, managed by the device owner.
6061 * Otherwise a {@link SecurityException} will be thrown.
Michal Karpinskib58e4962016-03-01 14:55:10 +00006062 *
Rubin Xuc3cd05f2016-01-11 12:11:35 +00006063 * @param admin Which device owner this request is associated with.
Michal Karpinski6235a942016-03-15 12:07:23 +00006064 * @param enabled whether security logging should be enabled or not.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07006065 * @throws SecurityException if {@code admin} is not a device owner.
Michal Karpinski6235a942016-03-15 12:07:23 +00006066 * @see #retrieveSecurityLogs
6067 */
6068 public void setSecurityLoggingEnabled(@NonNull ComponentName admin, boolean enabled) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01006069 throwIfParentInstance("setSecurityLoggingEnabled");
Michal Karpinski6235a942016-03-15 12:07:23 +00006070 try {
6071 mService.setSecurityLoggingEnabled(admin, enabled);
6072 } catch (RemoteException re) {
6073 throw re.rethrowFromSystemServer();
6074 }
6075 }
6076
6077 /**
Michal Karpinski6235a942016-03-15 12:07:23 +00006078 * Return whether security logging is enabled or not by the device owner.
6079 *
6080 * <p>Can only be called by the device owner, otherwise a {@link SecurityException} will be
6081 * thrown.
6082 *
6083 * @param admin Which device owner this request is associated with.
6084 * @return {@code true} if security logging is enabled by device owner, {@code false} otherwise.
6085 * @throws SecurityException if {@code admin} is not a device owner.
6086 */
6087 public boolean isSecurityLoggingEnabled(@NonNull ComponentName admin) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01006088 throwIfParentInstance("isSecurityLoggingEnabled");
Rubin Xuc3cd05f2016-01-11 12:11:35 +00006089 try {
Michal Karpinski6235a942016-03-15 12:07:23 +00006090 return mService.isSecurityLoggingEnabled(admin);
Rubin Xuc3cd05f2016-01-11 12:11:35 +00006091 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07006092 throw re.rethrowFromSystemServer();
Rubin Xuc3cd05f2016-01-11 12:11:35 +00006093 }
6094 }
6095
6096 /**
Michal Karpinski6235a942016-03-15 12:07:23 +00006097 * Called by device owner to retrieve all new security logging entries since the last call to
6098 * this API after device boots.
6099 *
6100 * <p> Access to the logs is rate limited and it will only return new logs after the device
6101 * owner has been notified via {@link DeviceAdminReceiver#onSecurityLogsAvailable}.
6102 *
6103 * <p>There must be only one user on the device, managed by the device owner.
6104 * Otherwise a {@link SecurityException} will be thrown.
Michal Karpinskib58e4962016-03-01 14:55:10 +00006105 *
Rubin Xuc3cd05f2016-01-11 12:11:35 +00006106 * @param admin Which device owner this request is associated with.
Michal Karpinski6235a942016-03-15 12:07:23 +00006107 * @return the new batch of security logs which is a list of {@link SecurityEvent},
6108 * or {@code null} if rate limitation is exceeded or if logging is currently disabled.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07006109 * @throws SecurityException if {@code admin} is not a device owner.
Rubin Xuc3cd05f2016-01-11 12:11:35 +00006110 */
Michal Karpinski6235a942016-03-15 12:07:23 +00006111 public List<SecurityEvent> retrieveSecurityLogs(@NonNull ComponentName admin) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01006112 throwIfParentInstance("retrieveSecurityLogs");
Rubin Xuc3cd05f2016-01-11 12:11:35 +00006113 try {
Michal Karpinski6235a942016-03-15 12:07:23 +00006114 ParceledListSlice<SecurityEvent> list = mService.retrieveSecurityLogs(admin);
Rubin Xuc3cd05f2016-01-11 12:11:35 +00006115 if (list != null) {
6116 return list.getList();
6117 } else {
6118 // Rate limit exceeded.
6119 return null;
6120 }
Clara Bayarri3e826ef2015-12-14 17:51:22 +00006121 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07006122 throw re.rethrowFromSystemServer();
Clara Bayarri3e826ef2015-12-14 17:51:22 +00006123 }
6124 }
Benjamin Franz59720bb2016-01-18 15:26:11 +00006125
6126 /**
Sudheer Shanka978fc0d2016-01-28 13:51:10 +00006127 * Called by the system to obtain a {@link DevicePolicyManager} whose calls act on the parent
6128 * profile.
6129 *
6130 * @hide
6131 */
6132 public DevicePolicyManager getParentProfileInstance(UserInfo uInfo) {
6133 mContext.checkSelfPermission(
6134 android.Manifest.permission.MANAGE_PROFILE_AND_DEVICE_OWNERS);
6135 if (!uInfo.isManagedProfile()) {
6136 throw new SecurityException("The user " + uInfo.id
6137 + " does not have a parent profile.");
6138 }
6139 return new DevicePolicyManager(mContext, true);
6140 }
6141
6142 /**
Rubin Xuc3cd05f2016-01-11 12:11:35 +00006143 * Called by device owners to retrieve device logs from before the device's last reboot.
Rubin Xuc3cd05f2016-01-11 12:11:35 +00006144 * <p>
Rubin Xu0fb6b9e2016-05-04 19:01:07 +01006145 * <strong> This API is not supported on all devices. Calling this API on unsupported devices
6146 * will result in {@code null} being returned. The device logs are retrieved from a RAM region
6147 * which is not guaranteed to be corruption-free during power cycles, as a result be cautious
6148 * about data corruption when parsing. </strong>
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07006149 * <p>
6150 * There must be only one user on the device, managed by the device owner. Otherwise a
6151 * {@link SecurityException} will be thrown.
Michal Karpinskib58e4962016-03-01 14:55:10 +00006152 *
Rubin Xuc3cd05f2016-01-11 12:11:35 +00006153 * @param admin Which device owner this request is associated with.
Rubin Xu0fb6b9e2016-05-04 19:01:07 +01006154 * @return Device logs from before the latest reboot of the system, or {@code null} if this API
6155 * is not supported on the device.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07006156 * @throws SecurityException if {@code admin} is not a device owner.
Rubin Xuc3cd05f2016-01-11 12:11:35 +00006157 */
Michal Karpinski6235a942016-03-15 12:07:23 +00006158 public List<SecurityEvent> retrievePreRebootSecurityLogs(@NonNull ComponentName admin) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01006159 throwIfParentInstance("retrievePreRebootSecurityLogs");
Rubin Xuc3cd05f2016-01-11 12:11:35 +00006160 try {
Michal Karpinski6235a942016-03-15 12:07:23 +00006161 ParceledListSlice<SecurityEvent> list = mService.retrievePreRebootSecurityLogs(admin);
Rubin Xu0fb6b9e2016-05-04 19:01:07 +01006162 if (list != null) {
6163 return list.getList();
6164 } else {
6165 return null;
6166 }
Rubin Xuc3cd05f2016-01-11 12:11:35 +00006167 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07006168 throw re.rethrowFromSystemServer();
Rubin Xuc3cd05f2016-01-11 12:11:35 +00006169 }
6170 }
6171
6172 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07006173 * Called by a profile owner of a managed profile to set the color used for customization. This
6174 * color is used as background color of the confirm credentials screen for that user. The
Clara Bayarri8d0bd7fa2016-03-30 14:59:58 +01006175 * default color is teal (#00796B).
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07006176 * <p>
6177 * The confirm credentials screen can be created using
Benjamin Franz59720bb2016-01-18 15:26:11 +00006178 * {@link android.app.KeyguardManager#createConfirmDeviceCredentialIntent}.
6179 *
6180 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
Michal Karpinski74cd7302016-04-12 15:17:36 +01006181 * @param color The 24bit (0xRRGGBB) representation of the color to be used.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07006182 * @throws SecurityException if {@code admin} is not a profile owner.
Benjamin Franz59720bb2016-01-18 15:26:11 +00006183 */
6184 public void setOrganizationColor(@NonNull ComponentName admin, int color) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01006185 throwIfParentInstance("setOrganizationColor");
Benjamin Franz59720bb2016-01-18 15:26:11 +00006186 try {
Michal Karpinski74cd7302016-04-12 15:17:36 +01006187 // always enforce alpha channel to have 100% opacity
6188 color |= 0xFF000000;
Benjamin Franz59720bb2016-01-18 15:26:11 +00006189 mService.setOrganizationColor(admin, color);
6190 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07006191 throw re.rethrowFromSystemServer();
Benjamin Franz59720bb2016-01-18 15:26:11 +00006192 }
6193 }
6194
6195 /**
Nicolas Prevot8f7698a2016-02-11 16:05:33 +00006196 * @hide
6197 *
6198 * Sets the color used for customization.
6199 *
Michal Karpinski74cd7302016-04-12 15:17:36 +01006200 * @param color The 24bit (0xRRGGBB) representation of the color to be used.
Nicolas Prevot8f7698a2016-02-11 16:05:33 +00006201 * @param userId which user to set the color to.
6202 * @RequiresPermission(allOf = {
6203 * Manifest.permission.MANAGE_USERS,
6204 * Manifest.permission.INTERACT_ACROSS_USERS_FULL})
6205 */
6206 public void setOrganizationColorForUser(@ColorInt int color, @UserIdInt int userId) {
6207 try {
Michal Karpinski74cd7302016-04-12 15:17:36 +01006208 // always enforce alpha channel to have 100% opacity
6209 color |= 0xFF000000;
Nicolas Prevot8f7698a2016-02-11 16:05:33 +00006210 mService.setOrganizationColorForUser(color, userId);
6211 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07006212 throw re.rethrowFromSystemServer();
Nicolas Prevot8f7698a2016-02-11 16:05:33 +00006213 }
6214 }
6215
6216 /**
Benjamin Franz59720bb2016-01-18 15:26:11 +00006217 * Called by a profile owner of a managed profile to retrieve the color used for customization.
6218 * This color is used as background color of the confirm credentials screen for that user.
6219 *
6220 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
Michal Karpinski74cd7302016-04-12 15:17:36 +01006221 * @return The 24bit (0xRRGGBB) representation of the color to be used.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07006222 * @throws SecurityException if {@code admin} is not a profile owner.
Benjamin Franz59720bb2016-01-18 15:26:11 +00006223 */
Michal Karpinski74cd7302016-04-12 15:17:36 +01006224 public @ColorInt int getOrganizationColor(@NonNull ComponentName admin) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01006225 throwIfParentInstance("getOrganizationColor");
Benjamin Franz59720bb2016-01-18 15:26:11 +00006226 try {
6227 return mService.getOrganizationColor(admin);
6228 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07006229 throw re.rethrowFromSystemServer();
Benjamin Franz59720bb2016-01-18 15:26:11 +00006230 }
6231 }
6232
6233 /**
6234 * @hide
6235 * Retrieve the customization color for a given user.
6236 *
6237 * @param userHandle The user id of the user we're interested in.
Michal Karpinski74cd7302016-04-12 15:17:36 +01006238 * @return The 24bit (0xRRGGBB) representation of the color to be used.
Benjamin Franz59720bb2016-01-18 15:26:11 +00006239 */
Michal Karpinski74cd7302016-04-12 15:17:36 +01006240 public @ColorInt int getOrganizationColorForUser(int userHandle) {
Benjamin Franz59720bb2016-01-18 15:26:11 +00006241 try {
6242 return mService.getOrganizationColorForUser(userHandle);
6243 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07006244 throw re.rethrowFromSystemServer();
Benjamin Franz59720bb2016-01-18 15:26:11 +00006245 }
6246 }
Bartosz Fabianowski4c052f22016-01-25 14:18:43 +01006247
6248 /**
Benjamin Franz3e8a7092016-01-25 16:19:08 +00006249 * Called by a profile owner of a managed profile to set the name of the organization under
6250 * management.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07006251 * <p>
6252 * If the organization name needs to be localized, it is the responsibility of the
Benjamin Franz3e8a7092016-01-25 16:19:08 +00006253 * {@link DeviceAdminReceiver} to listen to the {@link Intent#ACTION_LOCALE_CHANGED} broadcast
6254 * and set a new version of this string accordingly.
6255 *
6256 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
6257 * @param title The organization name or {@code null} to clear a previously set name.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07006258 * @throws SecurityException if {@code admin} is not a profile owner.
Benjamin Franz3e8a7092016-01-25 16:19:08 +00006259 */
Michal Karpinski74cd7302016-04-12 15:17:36 +01006260 public void setOrganizationName(@NonNull ComponentName admin, @Nullable CharSequence title) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01006261 throwIfParentInstance("setOrganizationName");
Benjamin Franz3e8a7092016-01-25 16:19:08 +00006262 try {
6263 mService.setOrganizationName(admin, title);
6264 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07006265 throw re.rethrowFromSystemServer();
Benjamin Franz3e8a7092016-01-25 16:19:08 +00006266 }
6267 }
6268
6269 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07006270 * Called by a profile owner of a managed profile to retrieve the name of the organization under
6271 * management.
Benjamin Franz3e8a7092016-01-25 16:19:08 +00006272 *
6273 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
6274 * @return The organization name or {@code null} if none is set.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07006275 * @throws SecurityException if {@code admin} is not a profile owner.
Benjamin Franz3e8a7092016-01-25 16:19:08 +00006276 */
Michal Karpinski74cd7302016-04-12 15:17:36 +01006277 public CharSequence getOrganizationName(@NonNull ComponentName admin) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01006278 throwIfParentInstance("getOrganizationName");
Benjamin Franz3e8a7092016-01-25 16:19:08 +00006279 try {
6280 return mService.getOrganizationName(admin);
6281 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07006282 throw re.rethrowFromSystemServer();
Benjamin Franz3e8a7092016-01-25 16:19:08 +00006283 }
6284 }
6285
6286 /**
6287 * Retrieve the default title message used in the confirm credentials screen for a given user.
6288 *
6289 * @param userHandle The user id of the user we're interested in.
6290 * @return The organization name or {@code null} if none is set.
6291 *
6292 * @hide
6293 */
Michal Karpinski74cd7302016-04-12 15:17:36 +01006294 public CharSequence getOrganizationNameForUser(int userHandle) {
Benjamin Franz3e8a7092016-01-25 16:19:08 +00006295 try {
6296 return mService.getOrganizationNameForUser(userHandle);
6297 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07006298 throw re.rethrowFromSystemServer();
Benjamin Franz3e8a7092016-01-25 16:19:08 +00006299 }
6300 }
6301
6302 /**
Alan Treadwayafad8782016-01-19 15:15:08 +00006303 * @return the {@link UserProvisioningState} for the current user - for unmanaged users will
6304 * return {@link #STATE_USER_UNMANAGED}
6305 * @hide
6306 */
Benjamin Franzeed2a8e2016-02-19 14:19:05 +00006307 @SystemApi
Alan Treadwayafad8782016-01-19 15:15:08 +00006308 @UserProvisioningState
6309 public int getUserProvisioningState() {
Benjamin Franzbc33c822016-04-15 08:57:52 +01006310 throwIfParentInstance("getUserProvisioningState");
Alan Treadwayafad8782016-01-19 15:15:08 +00006311 if (mService != null) {
6312 try {
6313 return mService.getUserProvisioningState();
6314 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07006315 throw e.rethrowFromSystemServer();
Alan Treadwayafad8782016-01-19 15:15:08 +00006316 }
6317 }
6318 return STATE_USER_UNMANAGED;
6319 }
6320
6321 /**
6322 * Set the {@link UserProvisioningState} for the supplied user, if they are managed.
6323 *
6324 * @param state to store
6325 * @param userHandle for user
6326 * @hide
6327 */
6328 public void setUserProvisioningState(@UserProvisioningState int state, int userHandle) {
6329 if (mService != null) {
6330 try {
6331 mService.setUserProvisioningState(state, userHandle);
6332 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07006333 throw e.rethrowFromSystemServer();
Alan Treadwayafad8782016-01-19 15:15:08 +00006334 }
6335 }
6336 }
6337
6338 /**
Bartosz Fabianowski4c052f22016-01-25 14:18:43 +01006339 * @hide
6340 * Indicates the entity that controls the device or profile owner. A user/profile is considered
6341 * affiliated if it is managed by the same entity as the device.
6342 *
6343 * <p> By definition, the user that the device owner runs on is always affiliated. Any other
6344 * user/profile is considered affiliated if the following conditions are both met:
6345 * <ul>
6346 * <li>The device owner and the user's/profile's profile owner have called this method,
6347 * specifying a set of opaque affiliation ids each. If the sets specified by the device owner
6348 * and a profile owner intersect, they must have come from the same source, which means that
6349 * the device owner and profile owner are controlled by the same entity.</li>
6350 * <li>The device owner's and profile owner's package names are the same.</li>
6351 * </ul>
6352 *
6353 * @param admin Which profile or device owner this request is associated with.
6354 * @param ids A set of opaque affiliation ids.
6355 */
6356 public void setAffiliationIds(@NonNull ComponentName admin, Set<String> ids) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01006357 throwIfParentInstance("setAffiliationIds");
Bartosz Fabianowski4c052f22016-01-25 14:18:43 +01006358 try {
6359 mService.setAffiliationIds(admin, new ArrayList<String>(ids));
6360 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07006361 throw e.rethrowFromSystemServer();
Bartosz Fabianowski4c052f22016-01-25 14:18:43 +01006362 }
6363 }
6364
6365 /**
6366 * @hide
6367 * Returns whether this user/profile is affiliated with the device. See
6368 * {@link #setAffiliationIds} for the definition of affiliation.
6369 *
6370 * @return whether this user/profile is affiliated with the device.
6371 */
6372 public boolean isAffiliatedUser() {
Benjamin Franzbc33c822016-04-15 08:57:52 +01006373 throwIfParentInstance("isAffiliatedUser");
Bartosz Fabianowski4c052f22016-01-25 14:18:43 +01006374 try {
6375 return mService != null && mService.isAffiliatedUser();
6376 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07006377 throw e.rethrowFromSystemServer();
Bartosz Fabianowski4c052f22016-01-25 14:18:43 +01006378 }
6379 }
Suprabh Shuklaa2ae2232016-01-28 18:05:14 -08006380
6381 /**
6382 * @hide
6383 * Returns whether the uninstall for {@code packageName} for the current user is in queue
6384 * to be started
6385 * @param packageName the package to check for
6386 * @return whether the uninstall intent for {@code packageName} is pending
6387 */
6388 public boolean isUninstallInQueue(String packageName) {
6389 try {
6390 return mService.isUninstallInQueue(packageName);
6391 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07006392 throw re.rethrowFromSystemServer();
Suprabh Shuklaa2ae2232016-01-28 18:05:14 -08006393 }
6394 }
6395
6396 /**
6397 * @hide
6398 * @param packageName the package containing active DAs to be uninstalled
6399 */
6400 public void uninstallPackageWithActiveAdmins(String packageName) {
6401 try {
6402 mService.uninstallPackageWithActiveAdmins(packageName);
6403 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07006404 throw re.rethrowFromSystemServer();
Suprabh Shuklaa2ae2232016-01-28 18:05:14 -08006405 }
6406 }
Benjamin Franzbc33c822016-04-15 08:57:52 +01006407
Kenny Guy38dcca52016-04-19 13:09:18 +01006408 /**
6409 * @hide
6410 * Remove a test admin synchronously without sending it a broadcast about being removed.
6411 * If the admin is a profile owner or device owner it will still be removed.
6412 *
6413 * @param userHandle user id to remove the admin for.
6414 * @param admin The administration compononent to remove.
6415 * @throws SecurityException if the caller is not shell / root or the admin package
6416 * isn't a test application see {@link ApplicationInfo#FLAG_TEST_APP}.
6417 */
6418 public void forceRemoveActiveAdmin(ComponentName adminReceiver, int userHandle) {
6419 try {
6420 mService.forceRemoveActiveAdmin(adminReceiver, userHandle);
6421 } catch (RemoteException re) {
6422 throw re.rethrowFromSystemServer();
6423 }
6424 }
6425
Mahaver Chopra790d1982016-07-07 16:06:49 +01006426 /**
6427 * @hide
6428 * @return whether {@link android.provider.Settings.Global#DEVICE_PROVISIONED} has ever been set
6429 * to 1.
6430 */
6431 public boolean isDeviceProvisioned() {
6432 try {
6433 return mService.isDeviceProvisioned();
6434 } catch (RemoteException re) {
6435 throw re.rethrowFromSystemServer();
6436 }
6437 }
6438
Benjamin Franz2aa9bab2016-07-11 19:10:36 +01006439 /**
6440 * @hide
6441 * Writes that the provisioning configuration has been applied.
6442 */
6443 public void setDeviceProvisioningConfigApplied() {
6444 try {
6445 mService.setDeviceProvisioningConfigApplied();
6446 } catch (RemoteException re) {
6447 throw re.rethrowFromSystemServer();
6448 }
6449 }
6450
6451 /**
6452 * @hide
6453 * @return whether the provisioning configuration has been applied.
6454 */
6455 public boolean isDeviceProvisioningConfigApplied() {
6456 try {
6457 return mService.isDeviceProvisioningConfigApplied();
6458 } catch (RemoteException re) {
6459 throw re.rethrowFromSystemServer();
6460 }
6461 }
6462
Benjamin Franzbc33c822016-04-15 08:57:52 +01006463 private void throwIfParentInstance(String functionName) {
6464 if (mParentInstance) {
6465 throw new SecurityException(functionName + " cannot be called on the parent instance");
6466 }
6467 }
Dianne Hackbornd6847842010-01-12 18:14:19 -08006468}