blob: 8db8dcf74fbadce72bc382ea5489b2111143de5d [file] [log] [blame]
Dianne Hackbornd6847842010-01-12 18:14:19 -08001/*
2 * Copyright (C) 2010 The Android Open Source Project
3 *
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
7 *
8 * http://www.apache.org/licenses/LICENSE-2.0
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 */
16
Dianne Hackborn87bba1e2010-02-26 17:25:54 -080017package android.app.admin;
Dianne Hackbornd6847842010-01-12 18:14:19 -080018
Nicolas Prevot8f7698a2016-02-11 16:05:33 +000019import android.annotation.ColorInt;
Alan Treadwayafad8782016-01-19 15:15:08 +000020import android.annotation.IntDef;
Robin Lee25e26452015-06-02 09:56:29 -070021import android.annotation.NonNull;
22import android.annotation.Nullable;
Dianne Hackbornd6847842010-01-12 18:14:19 -080023import android.annotation.SdkConstant;
24import android.annotation.SdkConstant.SdkConstantType;
Justin Moreyb5deda72014-07-24 10:53:40 -050025import android.annotation.SystemApi;
Nicolas Prevot8f7698a2016-02-11 16:05:33 +000026import android.annotation.UserIdInt;
Jason Monkd7b86212014-06-16 13:15:38 -040027import android.app.Activity;
Michal Karpinski6235a942016-03-15 12:07:23 +000028import android.app.admin.SecurityLog.SecurityEvent;
Dianne Hackbornd6847842010-01-12 18:14:19 -080029import android.content.ComponentName;
30import android.content.Context;
Adam Connors010cfd42014-04-16 12:48:13 +010031import android.content.Intent;
Sander Alewijnsef475ca32014-02-17 15:13:58 +000032import android.content.IntentFilter;
Dianne Hackbornd6847842010-01-12 18:14:19 -080033import android.content.pm.PackageManager;
Victor Changcd14c0a2016-03-16 19:10:15 +000034import android.content.pm.PackageManager.NameNotFoundException;
Rubin Xuc3cd05f2016-01-11 12:11:35 +000035import android.content.pm.ParceledListSlice;
Sudheer Shanka978fc0d2016-01-28 13:51:10 +000036import android.content.pm.UserInfo;
Julia Reynoldsfca04ca2015-02-17 13:39:12 -050037import android.graphics.Bitmap;
Jason Monk03bc9912014-05-13 09:44:57 -040038import android.net.ProxyInfo;
Nicolas Prevot8b7991c2015-11-12 17:40:12 +000039import android.net.Uri;
Robin Lee66e5d962014-04-09 16:44:21 +010040import android.os.Bundle;
Jim Millere303bf42014-08-26 17:12:29 -070041import android.os.PersistableBundle;
Adam Connors776c5552014-01-09 10:42:56 +000042import android.os.Process;
Dianne Hackborn8ea138c2010-01-26 18:01:04 -080043import android.os.RemoteCallback;
Dianne Hackbornd6847842010-01-12 18:14:19 -080044import android.os.RemoteException;
45import android.os.ServiceManager;
Amith Yamasani599dd7c2012-09-14 23:20:08 -070046import android.os.UserHandle;
Julia Reynolds1e958392014-05-16 14:25:21 -040047import android.os.UserManager;
Ricky Wai494b95d2015-11-20 16:07:15 +000048import android.provider.ContactsContract.Directory;
Mahaver Chopra1ce53bc2015-12-14 13:35:14 +000049import android.provider.Settings;
Bernhard Bauer26408cc2014-09-08 14:07:31 +010050import android.security.Credentials;
Amith Yamasanid1d7c022014-08-19 17:03:41 -070051import android.service.restrictions.RestrictionsReceiver;
Mahaver Chopra1216ae52016-03-11 15:39:48 +000052import android.telephony.TelephonyManager;
Dianne Hackbornd6847842010-01-12 18:14:19 -080053import android.util.Log;
54
Makoto Onukicc4bbeb2015-09-17 10:28:24 -070055import com.android.internal.annotations.VisibleForTesting;
Maggie Benthallda51e682013-08-08 22:35:44 -040056import com.android.org.conscrypt.TrustedCertificateStore;
57
58import java.io.ByteArrayInputStream;
Dianne Hackbornd6847842010-01-12 18:14:19 -080059import java.io.IOException;
Alan Treadwayafad8782016-01-19 15:15:08 +000060import java.lang.annotation.Retention;
61import java.lang.annotation.RetentionPolicy;
Oscar Montemayor69238c62010-08-03 10:51:06 -070062import java.net.InetSocketAddress;
63import java.net.Proxy;
Robin Lee0d5ccb72014-09-12 17:41:44 +010064import java.security.KeyFactory;
Mahaver Chopra1ce53bc2015-12-14 13:35:14 +000065import java.security.NoSuchAlgorithmException;
Bernhard Bauer26408cc2014-09-08 14:07:31 +010066import java.security.PrivateKey;
67import java.security.cert.Certificate;
Maggie Benthallda51e682013-08-08 22:35:44 -040068import java.security.cert.CertificateException;
69import java.security.cert.CertificateFactory;
70import java.security.cert.X509Certificate;
Robin Lee0d5ccb72014-09-12 17:41:44 +010071import java.security.spec.InvalidKeySpecException;
Mahaver Chopra1ce53bc2015-12-14 13:35:14 +000072import java.security.spec.PKCS8EncodedKeySpec;
Jim Miller604e7552014-07-18 19:00:02 -070073import java.util.ArrayList;
Rubin Xub4365912016-03-23 12:13:22 +000074import java.util.Arrays;
Svetoslav976e8bd2014-07-16 15:12:03 -070075import java.util.Collections;
Dianne Hackbornd47c6ed2010-01-27 16:21:20 -080076import java.util.List;
Bartosz Fabianowski4c052f22016-01-25 14:18:43 +010077import java.util.Set;
Dianne Hackbornd6847842010-01-12 18:14:19 -080078
79/**
Alexandra Gherghina541afcd2014-11-07 11:18:12 +000080 * Public interface for managing policies enforced on a device. Most clients of this class must be
Suprabh Shukla34d92ef2016-03-14 13:49:37 -070081 * registered with the system as a <a href="{@docRoot}guide/topics/admin/device-admin.html">device
82 * administrator</a>. Additionally, a device administrator may be registered as either a profile or
83 * device owner. A given method is accessible to all device administrators unless the documentation
84 * for that method specifies that it is restricted to either device or profile owners. Any
85 * application calling an api may only pass as an argument a device administrator component it
86 * owns. Otherwise, a {@link SecurityException} will be thrown.
Joe Fernandez3aef8e1d2011-12-20 10:38:34 -080087 * <div class="special reference">
88 * <h3>Developer Guides</h3>
Suprabh Shukla34d92ef2016-03-14 13:49:37 -070089 * <p>
90 * For more information about managing policies for device administration, read the <a href=
91 * "{@docRoot}guide/topics/admin/device-admin.html">Device Administration</a> developer
92 * guide. </div>
Dianne Hackbornd6847842010-01-12 18:14:19 -080093 */
94public class DevicePolicyManager {
95 private static String TAG = "DevicePolicyManager";
Dianne Hackbornd6847842010-01-12 18:14:19 -080096
97 private final Context mContext;
Dianne Hackbornd6847842010-01-12 18:14:19 -080098 private final IDevicePolicyManager mService;
Esteban Talavera62399912016-01-11 15:37:55 +000099 private final boolean mParentInstance;
Konstantin Lopyrev32558232010-05-20 16:18:05 -0700100
Clara Bayarri3e826ef2015-12-14 17:51:22 +0000101 private DevicePolicyManager(Context context, boolean parentInstance) {
Esteban Talavera62399912016-01-11 15:37:55 +0000102 this(context,
103 IDevicePolicyManager.Stub.asInterface(
104 ServiceManager.getService(Context.DEVICE_POLICY_SERVICE)),
105 parentInstance);
Dianne Hackbornd6847842010-01-12 18:14:19 -0800106 }
107
Dianne Hackborn87bba1e2010-02-26 17:25:54 -0800108 /** @hide */
Makoto Onukicc4bbeb2015-09-17 10:28:24 -0700109 @VisibleForTesting
Esteban Talavera62399912016-01-11 15:37:55 +0000110 protected DevicePolicyManager(
111 Context context, IDevicePolicyManager service, boolean parentInstance) {
Makoto Onukicc4bbeb2015-09-17 10:28:24 -0700112 mContext = context;
113 mService = service;
Esteban Talavera62399912016-01-11 15:37:55 +0000114 mParentInstance = parentInstance;
Makoto Onukicc4bbeb2015-09-17 10:28:24 -0700115 }
116
117 /** @hide */
118 public static DevicePolicyManager create(Context context) {
Clara Bayarri3e826ef2015-12-14 17:51:22 +0000119 DevicePolicyManager me = new DevicePolicyManager(context, false);
Dianne Hackborn21f1bd12010-02-19 17:02:21 -0800120 return me.mService != null ? me : null;
121 }
Konstantin Lopyrev32558232010-05-20 16:18:05 -0700122
Makoto Onukicc4bbeb2015-09-17 10:28:24 -0700123 /** @hide test will override it. */
124 @VisibleForTesting
125 protected int myUserId() {
126 return UserHandle.myUserId();
127 }
128
Dianne Hackbornd6847842010-01-12 18:14:19 -0800129 /**
Jessica Hummelf72078b2014-03-06 16:13:12 +0000130 * Activity action: Starts the provisioning flow which sets up a managed profile.
Jessica Hummelf72078b2014-03-06 16:13:12 +0000131 *
Jessica Hummel9da60392014-05-21 12:32:57 +0100132 * <p>A managed profile allows data separation for example for the usage of a
133 * device as a personal and corporate device. The user which provisioning is started from and
134 * the managed profile share a launcher.
135 *
Andrew Solovay27f53372015-03-02 16:37:59 -0800136 * <p>This intent will typically be sent by a mobile device management application (MDM).
137 * Provisioning adds a managed profile and sets the MDM as the profile owner who has full
138 * control over the profile.
Jessica Hummel9da60392014-05-21 12:32:57 +0100139 *
Alan Treadway46dd4492015-11-09 13:57:19 +0000140 * <p>It is possible to check if provisioning is allowed or not by querying the method
141 * {@link #isProvisioningAllowed(String)}.
142 *
143 * <p>In version {@link android.os.Build.VERSION_CODES#LOLLIPOP}, this intent must contain the
Nicolas Prevot18440252015-03-09 14:07:17 +0000144 * extra {@link #EXTRA_PROVISIONING_DEVICE_ADMIN_PACKAGE_NAME}.
Dianne Hackborn0e3de6c2015-07-29 15:20:21 -0700145 * As of {@link android.os.Build.VERSION_CODES#M}, it should contain the extra
Nicolas Prevot18440252015-03-09 14:07:17 +0000146 * {@link #EXTRA_PROVISIONING_DEVICE_ADMIN_COMPONENT_NAME} instead, although specifying only
147 * {@link #EXTRA_PROVISIONING_DEVICE_ADMIN_PACKAGE_NAME} is still supported.
Nicolas Prevotcaf11cd2015-11-19 10:58:35 +0000148 *
Benjamin Franzea956242016-03-21 15:45:56 +0000149 * <p>The intent may also contain the following extras:
Nicolas Prevotcaf11cd2015-11-19 10:58:35 +0000150 * <ul>
Benjamin Franzea956242016-03-21 15:45:56 +0000151 * <li>{@link #EXTRA_PROVISIONING_ACCOUNT_TO_MIGRATE}, optional </li>
152 * <li>{@link #EXTRA_PROVISIONING_SKIP_ENCRYPTION}, optional, supported from
153 * {@link android.os.Build.VERSION_CODES#N}</li>
154 * <li>{@link #EXTRA_PROVISIONING_ADMIN_EXTRAS_BUNDLE}, optional</li>
155 * <li>{@link #EXTRA_PROVISIONING_LOGO_URI}, optional</li>
156 * <li>{@link #EXTRA_PROVISIONING_MAIN_COLOR}, optional</li>
Nicolas Prevotcaf11cd2015-11-19 10:58:35 +0000157 * </ul>
Jessica Hummelf72078b2014-03-06 16:13:12 +0000158 *
Benjamin Franzea956242016-03-21 15:45:56 +0000159 * <p>When managed provisioning has completed, broadcasts are sent to the application specified
Alexandra Gherghinadb4bc572015-01-08 12:17:40 +0000160 * in the provisioning intent. The
161 * {@link DeviceAdminReceiver#ACTION_PROFILE_PROVISIONING_COMPLETE} broadcast is sent in the
162 * managed profile and the {@link #ACTION_MANAGED_PROFILE_PROVISIONED} broadcast is sent in
163 * the primary profile.
Jessica Hummel9da60392014-05-21 12:32:57 +0100164 *
Benjamin Franzea956242016-03-21 15:45:56 +0000165 * <p>If provisioning fails, the managedProfile is removed so the device returns to its
Sander Alewijnse1cc4ecc2014-06-23 19:56:52 +0100166 * previous state.
Alan Treadway4582f812015-07-28 11:49:35 +0100167 *
168 * <p>If launched with {@link android.app.Activity#startActivityForResult(Intent, int)} a
169 * result code of {@link android.app.Activity#RESULT_OK} implies that the synchronous part of
170 * the provisioning flow was successful, although this doesn't guarantee the full flow will
171 * succeed. Conversely a result code of {@link android.app.Activity#RESULT_CANCELED} implies
172 * that the user backed-out of provisioning, or some precondition for provisioning wasn't met.
Jessica Hummelf72078b2014-03-06 16:13:12 +0000173 */
174 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
175 public static final String ACTION_PROVISION_MANAGED_PROFILE
Esteban Talaveraef9c5232014-09-08 13:51:18 +0100176 = "android.app.action.PROVISION_MANAGED_PROFILE";
Jessica Hummelf72078b2014-03-06 16:13:12 +0000177
178 /**
Mahaver Chopra7830daa2015-11-10 18:12:43 +0000179 * Activity action: Starts the provisioning flow which sets up a managed user.
180 *
181 * <p>This intent will typically be sent by a mobile device management application (MDM).
Makoto Onuki32b30572015-12-11 14:29:51 -0800182 * Provisioning configures the user as managed user and sets the MDM as the profile
Mahaver Chopra7830daa2015-11-10 18:12:43 +0000183 * owner who has full control over the user. Provisioning can only happen before user setup has
184 * been completed. Use {@link #isProvisioningAllowed(String)} to check if provisioning is
185 * allowed.
186 *
Benjamin Franzea956242016-03-21 15:45:56 +0000187 * <p>The intent contains the following extras:
188 * <ul>
189 * <li>{@link #EXTRA_PROVISIONING_DEVICE_ADMIN_COMPONENT_NAME}</li>
190 * <li>{@link #EXTRA_PROVISIONING_SKIP_ENCRYPTION}, optional</li>
191 * <li>{@link #EXTRA_PROVISIONING_ADMIN_EXTRAS_BUNDLE}, optional</li>
192 * <li>{@link #EXTRA_PROVISIONING_LOGO_URI}, optional</li>
193 * <li>{@link #EXTRA_PROVISIONING_MAIN_COLOR}, optional</li>
194 * </ul>
Mahaver Chopra7830daa2015-11-10 18:12:43 +0000195 *
Benjamin Franzea956242016-03-21 15:45:56 +0000196 * <p>If provisioning fails, the device returns to its previous state.
Mahaver Chopra7830daa2015-11-10 18:12:43 +0000197 *
198 * <p>If launched with {@link android.app.Activity#startActivityForResult(Intent, int)} a
199 * result code of {@link android.app.Activity#RESULT_OK} implies that the synchronous part of
200 * the provisioning flow was successful, although this doesn't guarantee the full flow will
201 * succeed. Conversely a result code of {@link android.app.Activity#RESULT_CANCELED} implies
202 * that the user backed-out of provisioning, or some precondition for provisioning wasn't met.
Benjamin Franzea956242016-03-21 15:45:56 +0000203 *
204 * @hide
Mahaver Chopra5e732562015-11-05 11:55:12 +0000205 */
206 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
207 public static final String ACTION_PROVISION_MANAGED_USER
208 = "android.app.action.PROVISION_MANAGED_USER";
209
210 /**
Nicolas Prevot64bf7b22015-04-29 14:43:49 +0100211 * Activity action: Starts the provisioning flow which sets up a managed device.
212 * Must be started with {@link android.app.Activity#startActivityForResult(Intent, int)}.
213 *
214 * <p> During device owner provisioning a device admin app is set as the owner of the device.
215 * A device owner has full control over the device. The device owner can not be modified by the
216 * user.
217 *
218 * <p> A typical use case would be a device that is owned by a company, but used by either an
219 * employee or client.
220 *
221 * <p> An intent with this action can be sent only on an unprovisioned device.
Alan Treadway46dd4492015-11-09 13:57:19 +0000222 * It is possible to check if provisioning is allowed or not by querying the method
223 * {@link #isProvisioningAllowed(String)}.
Nicolas Prevot64bf7b22015-04-29 14:43:49 +0100224 *
Alan Treadway46dd4492015-11-09 13:57:19 +0000225 * <p>The intent contains the following extras:
Nicolas Prevot64bf7b22015-04-29 14:43:49 +0100226 * <ul>
227 * <li>{@link #EXTRA_PROVISIONING_DEVICE_ADMIN_COMPONENT_NAME}</li>
228 * <li>{@link #EXTRA_PROVISIONING_SKIP_ENCRYPTION}, optional</li>
229 * <li>{@link #EXTRA_PROVISIONING_LEAVE_ALL_SYSTEM_APPS_ENABLED}, optional</li>
Rubin Xua4f9dc12015-06-12 13:27:59 +0100230 * <li>{@link #EXTRA_PROVISIONING_ADMIN_EXTRAS_BUNDLE}, optional</li>
Nicolas Prevot8b7991c2015-11-12 17:40:12 +0000231 * <li>{@link #EXTRA_PROVISIONING_LOGO_URI}, optional</li>
Nicolas Prevotcaf11cd2015-11-19 10:58:35 +0000232 * <li>{@link #EXTRA_PROVISIONING_MAIN_COLOR}, optional</li>
Nicolas Prevot64bf7b22015-04-29 14:43:49 +0100233 * </ul>
234 *
Benjamin Franzea956242016-03-21 15:45:56 +0000235 * <p>When device owner provisioning has completed, an intent of the type
Nicolas Prevot64bf7b22015-04-29 14:43:49 +0100236 * {@link DeviceAdminReceiver#ACTION_PROFILE_PROVISIONING_COMPLETE} is broadcast to the
237 * device owner.
238 *
Benjamin Franzea956242016-03-21 15:45:56 +0000239 * <p>If provisioning fails, the device is factory reset.
Nicolas Prevot64bf7b22015-04-29 14:43:49 +0100240 *
Alan Treadway4582f812015-07-28 11:49:35 +0100241 * <p>A result code of {@link android.app.Activity#RESULT_OK} implies that the synchronous part
242 * of the provisioning flow was successful, although this doesn't guarantee the full flow will
243 * succeed. Conversely a result code of {@link android.app.Activity#RESULT_CANCELED} implies
244 * that the user backed-out of provisioning, or some precondition for provisioning wasn't met.
Nicolas Prevot64bf7b22015-04-29 14:43:49 +0100245 */
246 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
247 public static final String ACTION_PROVISION_MANAGED_DEVICE
248 = "android.app.action.PROVISION_MANAGED_DEVICE";
249
250 /**
Alan Treadway46dd4492015-11-09 13:57:19 +0000251 * Activity action: Starts the provisioning flow which sets up a managed device.
Steven Ng980a1b62016-02-02 17:43:18 +0000252 *
253 * <p>During device owner provisioning, a device admin app is downloaded and set as the owner of
254 * the device. A device owner has full control over the device. The device owner can not be
255 * modified by the user and the only way of resetting the device is via factory reset.
256 *
257 * <p>A typical use case would be a device that is owned by a company, but used by either an
258 * employee or client.
259 *
260 * <p>The provisioning message should be sent to an unprovisioned device.
261 *
262 * <p>Unlike {@link #ACTION_PROVISION_MANAGED_DEVICE}, the provisioning message can only be sent
263 * by a privileged app with the permission
264 * {@link android.Manifest.permission#DISPATCH_PROVISIONING_MESSAGE}.
265 *
266 * <p>The provisioning intent contains the following properties:
267 * <ul>
268 * <li>{@link #EXTRA_PROVISIONING_DEVICE_ADMIN_COMPONENT_NAME}</li>
269 * <li>{@link #EXTRA_PROVISIONING_DEVICE_ADMIN_PACKAGE_DOWNLOAD_LOCATION}, optional</li>
270 * <li>{@link #EXTRA_PROVISIONING_DEVICE_ADMIN_PACKAGE_DOWNLOAD_COOKIE_HEADER}, optional</li>
271 * <li>{@link #EXTRA_PROVISIONING_DEVICE_ADMIN_PACKAGE_CHECKSUM}, optional</li>
272 * <li>{@link #EXTRA_PROVISIONING_LOCAL_TIME} (convert to String), optional</li>
273 * <li>{@link #EXTRA_PROVISIONING_TIME_ZONE}, optional</li>
274 * <li>{@link #EXTRA_PROVISIONING_LOCALE}, optional</li>
275 * <li>{@link #EXTRA_PROVISIONING_WIFI_SSID}, optional</li>
276 * <li>{@link #EXTRA_PROVISIONING_WIFI_HIDDEN} (convert to String), optional</li>
277 * <li>{@link #EXTRA_PROVISIONING_WIFI_SECURITY_TYPE}, optional</li>
278 * <li>{@link #EXTRA_PROVISIONING_WIFI_PASSWORD}, optional</li>
279 * <li>{@link #EXTRA_PROVISIONING_WIFI_PROXY_HOST}, optional</li>
280 * <li>{@link #EXTRA_PROVISIONING_WIFI_PROXY_PORT} (convert to String), optional</li>
281 * <li>{@link #EXTRA_PROVISIONING_WIFI_PROXY_BYPASS}, optional</li>
282 * <li>{@link #EXTRA_PROVISIONING_WIFI_PAC_URL}, optional</li>
283 * <li>{@link #EXTRA_PROVISIONING_ADMIN_EXTRAS_BUNDLE}, optional</li></ul>
284 *
285 * @hide
286 */
287 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
288 @SystemApi
289 public static final String ACTION_PROVISION_MANAGED_DEVICE_FROM_TRUSTED_SOURCE =
290 "android.app.action.PROVISION_MANAGED_DEVICE_FROM_TRUSTED_SOURCE";
291
292 /**
293 * Activity action: Starts the provisioning flow which sets up a managed device.
Alan Treadway46dd4492015-11-09 13:57:19 +0000294 * Must be started with {@link android.app.Activity#startActivityForResult(Intent, int)}.
295 *
296 * <p>NOTE: This is only supported on split system user devices, and puts the device into a
297 * management state that is distinct from that reached by
298 * {@link #ACTION_PROVISION_MANAGED_DEVICE} - specifically the device owner runs on the system
299 * user, and only has control over device-wide policies, not individual users and their data.
300 * The primary benefit is that multiple non-system users are supported when provisioning using
301 * this form of device management.
302 *
Benjamin Franzea956242016-03-21 15:45:56 +0000303 * <p>During device owner provisioning a device admin app is set as the owner of the device.
Alan Treadway46dd4492015-11-09 13:57:19 +0000304 * A device owner has full control over the device. The device owner can not be modified by the
305 * user.
306 *
Benjamin Franzea956242016-03-21 15:45:56 +0000307 * <p>A typical use case would be a device that is owned by a company, but used by either an
Alan Treadway46dd4492015-11-09 13:57:19 +0000308 * employee or client.
309 *
Benjamin Franzea956242016-03-21 15:45:56 +0000310 * <p>An intent with this action can be sent only on an unprovisioned device.
Alan Treadway46dd4492015-11-09 13:57:19 +0000311 * It is possible to check if provisioning is allowed or not by querying the method
312 * {@link #isProvisioningAllowed(String)}.
313 *
314 * <p>The intent contains the following extras:
315 * <ul>
316 * <li>{@link #EXTRA_PROVISIONING_DEVICE_ADMIN_COMPONENT_NAME}</li>
317 * <li>{@link #EXTRA_PROVISIONING_SKIP_ENCRYPTION}, optional</li>
318 * <li>{@link #EXTRA_PROVISIONING_LEAVE_ALL_SYSTEM_APPS_ENABLED}, optional</li>
319 * <li>{@link #EXTRA_PROVISIONING_ADMIN_EXTRAS_BUNDLE}, optional</li>
Benjamin Franzea956242016-03-21 15:45:56 +0000320 * <li>{@link #EXTRA_PROVISIONING_LOGO_URI}, optional</li>
321 * <li>{@link #EXTRA_PROVISIONING_MAIN_COLOR}, optional</li>
Alan Treadway46dd4492015-11-09 13:57:19 +0000322 * </ul>
323 *
Benjamin Franzea956242016-03-21 15:45:56 +0000324 * <p>When device owner provisioning has completed, an intent of the type
Alan Treadway46dd4492015-11-09 13:57:19 +0000325 * {@link DeviceAdminReceiver#ACTION_PROFILE_PROVISIONING_COMPLETE} is broadcast to the
326 * device owner.
327 *
Benjamin Franzea956242016-03-21 15:45:56 +0000328 * <p>If provisioning fails, the device is factory reset.
Alan Treadway46dd4492015-11-09 13:57:19 +0000329 *
330 * <p>A result code of {@link android.app.Activity#RESULT_OK} implies that the synchronous part
331 * of the provisioning flow was successful, although this doesn't guarantee the full flow will
332 * succeed. Conversely a result code of {@link android.app.Activity#RESULT_CANCELED} implies
333 * that the user backed-out of provisioning, or some precondition for provisioning wasn't met.
334 *
335 * @hide
336 */
337 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
338 public static final String ACTION_PROVISION_MANAGED_SHAREABLE_DEVICE
339 = "android.app.action.PROVISION_MANAGED_SHAREABLE_DEVICE";
340
341 /**
Alan Treadwayafad8782016-01-19 15:15:08 +0000342 * Activity action: Finalizes management provisioning, should be used after user-setup
343 * has been completed and {@link #getUserProvisioningState()} returns one of:
344 * <ul>
345 * <li>{@link #STATE_USER_SETUP_INCOMPLETE}</li>
346 * <li>{@link #STATE_USER_SETUP_COMPLETE}</li>
347 * <li>{@link #STATE_USER_PROFILE_COMPLETE}</li>
348 * </ul>
349 *
350 * @hide
351 */
Benjamin Franzeed2a8e2016-02-19 14:19:05 +0000352 @SystemApi
Alan Treadwayafad8782016-01-19 15:15:08 +0000353 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
354 public static final String ACTION_PROVISION_FINALIZATION
355 = "android.app.action.PROVISION_FINALIZATION";
356
357 /**
Michal Karpinskiba244092016-02-25 17:28:24 +0000358 * Action: Bugreport sharing with device owner has been accepted by the user.
359 *
360 * @hide
361 */
362 public static final String ACTION_BUGREPORT_SHARING_ACCEPTED =
363 "com.android.server.action.BUGREPORT_SHARING_ACCEPTED";
364
365 /**
366 * Action: Bugreport sharing with device owner has been declined by the user.
367 *
368 * @hide
369 */
370 public static final String ACTION_BUGREPORT_SHARING_DECLINED =
371 "com.android.server.action.BUGREPORT_SHARING_DECLINED";
372
373 /**
374 * Action: Bugreport has been collected and is dispatched to {@link DevicePolicyManagerService}.
375 *
376 * @hide
377 */
378 public static final String ACTION_REMOTE_BUGREPORT_DISPATCH =
379 "android.intent.action.REMOTE_BUGREPORT_DISPATCH";
380
381 /**
382 * Extra for shared bugreport's SHA-256 hash.
383 *
384 * @hide
385 */
386 public static final String EXTRA_REMOTE_BUGREPORT_HASH =
387 "android.intent.extra.REMOTE_BUGREPORT_HASH";
388
389 /**
390 * Extra for remote bugreport notification shown type.
391 *
392 * @hide
393 */
394 public static final String EXTRA_BUGREPORT_NOTIFICATION_TYPE =
395 "android.app.extra.bugreport_notification_type";
396
397 /**
398 * Notification type for a started remote bugreport flow.
399 *
400 * @hide
401 */
402 public static final int NOTIFICATION_BUGREPORT_STARTED = 1;
403
404 /**
405 * Notification type for a bugreport that has already been accepted to be shared, but is still
406 * being taken.
407 *
408 * @hide
409 */
410 public static final int NOTIFICATION_BUGREPORT_ACCEPTED_NOT_FINISHED = 2;
411
412 /**
413 * Notification type for a bugreport that has been taken and can be shared or declined.
414 *
415 * @hide
416 */
417 public static final int NOTIFICATION_BUGREPORT_FINISHED_NOT_ACCEPTED = 3;
418
419 /**
Rubin Xua4f9dc12015-06-12 13:27:59 +0100420 * A {@link android.os.Parcelable} extra of type {@link android.os.PersistableBundle} that
Rubin Xu41f2ccb92015-08-05 16:29:13 +0100421 * allows a mobile device management application or NFC programmer application which starts
422 * managed provisioning to pass data to the management application instance after provisioning.
Rubin Xua4f9dc12015-06-12 13:27:59 +0100423 * <p>
424 * If used with {@link #ACTION_PROVISION_MANAGED_PROFILE} it can be used by the application that
425 * sends the intent to pass data to itself on the newly created profile.
426 * If used with {@link #ACTION_PROVISION_MANAGED_DEVICE} it allows passing data to the same
427 * instance of the app on the primary user.
Rubin Xu41f2ccb92015-08-05 16:29:13 +0100428 * Starting from {@link android.os.Build.VERSION_CODES#M}, if used with
429 * {@link #MIME_TYPE_PROVISIONING_NFC} as part of NFC managed device provisioning, the NFC
430 * message should contain a stringified {@link java.util.Properties} instance, whose string
431 * properties will be converted into a {@link android.os.PersistableBundle} and passed to the
432 * management application after provisioning.
433 *
Rubin Xua4f9dc12015-06-12 13:27:59 +0100434 * <p>
435 * In both cases the application receives the data in
Brian Carlstromf1fe51b2014-09-03 08:55:05 -0700436 * {@link DeviceAdminReceiver#onProfileProvisioningComplete} via an intent with the action
437 * {@link DeviceAdminReceiver#ACTION_PROFILE_PROVISIONING_COMPLETE}. The bundle is not changed
Rubin Xua4f9dc12015-06-12 13:27:59 +0100438 * during the managed provisioning.
Sander Alewijnse90f14bf2014-08-20 16:22:44 +0100439 */
440 public static final String EXTRA_PROVISIONING_ADMIN_EXTRAS_BUNDLE =
Esteban Talavera37f01842014-09-05 10:50:57 +0100441 "android.app.extra.PROVISIONING_ADMIN_EXTRAS_BUNDLE";
Sander Alewijnse90f14bf2014-08-20 16:22:44 +0100442
443 /**
Sander Alewijnse1cc4ecc2014-06-23 19:56:52 +0100444 * A String extra holding the package name of the mobile device management application that
445 * will be set as the profile owner or device owner.
446 *
447 * <p>If an application starts provisioning directly via an intent with action
448 * {@link #ACTION_PROVISION_MANAGED_PROFILE} this package has to match the package name of the
449 * application that started provisioning. The package will be set as profile owner in that case.
450 *
Sander Alewijnse8c411562014-11-12 18:03:11 +0000451 * <p>This package is set as device owner when device owner provisioning is started by an NFC
452 * message containing an NFC record with MIME type {@link #MIME_TYPE_PROVISIONING_NFC}.
Nicolas Prevot18440252015-03-09 14:07:17 +0000453 *
454 * <p> When this extra is set, the application must have exactly one device admin receiver.
Robin Lee25e26452015-06-02 09:56:29 -0700455 * This receiver will be set as the profile or device owner and active admin.
Benjamin Franzea956242016-03-21 15:45:56 +0000456 *
Nicolas Prevot18440252015-03-09 14:07:17 +0000457 * @see DeviceAdminReceiver
458 * @deprecated Use {@link #EXTRA_PROVISIONING_DEVICE_ADMIN_COMPONENT_NAME}. This extra is still
Nicolas Prevot8f78d6a2015-08-21 11:06:31 +0100459 * supported, but only if there is only one device admin receiver in the package that requires
460 * the permission {@link android.Manifest.permission#BIND_DEVICE_ADMIN}.
Jessica Hummelf72078b2014-03-06 16:13:12 +0000461 */
Nicolas Prevot18440252015-03-09 14:07:17 +0000462 @Deprecated
Jessica Hummelf72078b2014-03-06 16:13:12 +0000463 public static final String EXTRA_PROVISIONING_DEVICE_ADMIN_PACKAGE_NAME
Esteban Talaveraef9c5232014-09-08 13:51:18 +0100464 = "android.app.extra.PROVISIONING_DEVICE_ADMIN_PACKAGE_NAME";
Jessica Hummelf72078b2014-03-06 16:13:12 +0000465
466 /**
Nicolas Prevot18440252015-03-09 14:07:17 +0000467 * A ComponentName extra indicating the device admin receiver of the mobile device management
468 * application that will be set as the profile owner or device owner and active admin.
469 *
470 * <p>If an application starts provisioning directly via an intent with action
Nicolas Prevot64bf7b22015-04-29 14:43:49 +0100471 * {@link #ACTION_PROVISION_MANAGED_PROFILE} or
472 * {@link #ACTION_PROVISION_MANAGED_DEVICE} the package name of this
473 * component has to match the package name of the application that started provisioning.
Nicolas Prevot18440252015-03-09 14:07:17 +0000474 *
475 * <p>This component is set as device owner and active admin when device owner provisioning is
Nicolas Prevot64bf7b22015-04-29 14:43:49 +0100476 * started by an intent with action {@link #ACTION_PROVISION_MANAGED_DEVICE} or by an NFC
477 * message containing an NFC record with MIME type
Benjamin Franzea956242016-03-21 15:45:56 +0000478 * {@link #MIME_TYPE_PROVISIONING_NFC}. For the NFC record, the component name must be
Rubin Xu44ef750b2015-03-23 16:51:33 +0000479 * flattened to a string, via {@link ComponentName#flattenToShortString()}.
Nicolas Prevot18440252015-03-09 14:07:17 +0000480 *
481 * @see DeviceAdminReceiver
482 */
483 public static final String EXTRA_PROVISIONING_DEVICE_ADMIN_COMPONENT_NAME
484 = "android.app.extra.PROVISIONING_DEVICE_ADMIN_COMPONENT_NAME";
485
486 /**
Alexandra Gherghinaaaf2f3e2014-11-13 12:46:15 +0000487 * An {@link android.accounts.Account} extra holding the account to migrate during managed
488 * profile provisioning. If the account supplied is present in the primary user, it will be
489 * copied, along with its credentials to the managed profile and removed from the primary user.
490 *
491 * Use with {@link #ACTION_PROVISION_MANAGED_PROFILE}.
492 */
493
494 public static final String EXTRA_PROVISIONING_ACCOUNT_TO_MIGRATE
495 = "android.app.extra.PROVISIONING_ACCOUNT_TO_MIGRATE";
496
497 /**
Jessica Hummele3da7902014-08-20 15:20:11 +0100498 * A String extra that, holds the email address of the account which a managed profile is
499 * created for. Used with {@link #ACTION_PROVISION_MANAGED_PROFILE} and
500 * {@link DeviceAdminReceiver#ACTION_PROFILE_PROVISIONING_COMPLETE}.
Sander Alewijnse1cc4ecc2014-06-23 19:56:52 +0100501 *
Sander Alewijnse2b338a22014-09-12 12:28:40 +0100502 * <p> This extra is part of the {@link #EXTRA_PROVISIONING_ADMIN_EXTRAS_BUNDLE}.
503 *
Jessica Hummele3da7902014-08-20 15:20:11 +0100504 * <p> If the {@link #ACTION_PROVISION_MANAGED_PROFILE} intent that starts managed provisioning
505 * contains this extra, it is forwarded in the
506 * {@link DeviceAdminReceiver#ACTION_PROFILE_PROVISIONING_COMPLETE} intent to the mobile
507 * device management application that was set as the profile owner during provisioning.
508 * It is usually used to avoid that the user has to enter their email address twice.
Nicolas Prevot07ac20b2014-05-27 15:37:45 +0100509 */
Sander Alewijnse2b338a22014-09-12 12:28:40 +0100510 public static final String EXTRA_PROVISIONING_EMAIL_ADDRESS
511 = "android.app.extra.PROVISIONING_EMAIL_ADDRESS";
Nicolas Prevot07ac20b2014-05-27 15:37:45 +0100512
513 /**
Nicolas Prevotcd2d8592015-11-23 13:27:21 +0000514 * A integer extra indicating the predominant color to show during the provisioning.
515 * Refer to {@link android.graphics.Color} for how the color is represented.
Nicolas Prevotcaf11cd2015-11-19 10:58:35 +0000516 *
517 * <p>Use with {@link #ACTION_PROVISION_MANAGED_PROFILE} or
518 * {@link #ACTION_PROVISION_MANAGED_DEVICE}.
519 */
520 public static final String EXTRA_PROVISIONING_MAIN_COLOR =
521 "android.app.extra.PROVISIONING_MAIN_COLOR";
522
523 /**
Sander Alewijnse8c411562014-11-12 18:03:11 +0000524 * A Boolean extra that can be used by the mobile device management application to skip the
Robin Lee25e26452015-06-02 09:56:29 -0700525 * disabling of system apps during provisioning when set to {@code true}.
Sander Alewijnse8c411562014-11-12 18:03:11 +0000526 *
Nicolas Prevot64bf7b22015-04-29 14:43:49 +0100527 * <p>Use in an NFC record with {@link #MIME_TYPE_PROVISIONING_NFC} or an intent with action
528 * {@link #ACTION_PROVISION_MANAGED_DEVICE} that starts device owner provisioning.
Sander Alewijnse8c411562014-11-12 18:03:11 +0000529 */
Sander Alewijnse5a144252014-11-18 13:25:04 +0000530 public static final String EXTRA_PROVISIONING_LEAVE_ALL_SYSTEM_APPS_ENABLED =
531 "android.app.extra.PROVISIONING_LEAVE_ALL_SYSTEM_APPS_ENABLED";
Sander Alewijnse8c411562014-11-12 18:03:11 +0000532
533 /**
Sander Alewijnse1cc4ecc2014-06-23 19:56:52 +0100534 * A String extra holding the time zone {@link android.app.AlarmManager} that the device
535 * will be set to.
536 *
Sander Alewijnse8c411562014-11-12 18:03:11 +0000537 * <p>Use in an NFC record with {@link #MIME_TYPE_PROVISIONING_NFC} that starts device owner
538 * provisioning via an NFC bump.
Sander Alewijnse1cc4ecc2014-06-23 19:56:52 +0100539 */
540 public static final String EXTRA_PROVISIONING_TIME_ZONE
Esteban Talavera37f01842014-09-05 10:50:57 +0100541 = "android.app.extra.PROVISIONING_TIME_ZONE";
Sander Alewijnse1cc4ecc2014-06-23 19:56:52 +0100542
543 /**
Esteban Talaverad469a0b2014-08-20 13:54:25 +0100544 * A Long extra holding the wall clock time (in milliseconds) to be set on the device's
545 * {@link android.app.AlarmManager}.
Sander Alewijnse1cc4ecc2014-06-23 19:56:52 +0100546 *
Sander Alewijnse8c411562014-11-12 18:03:11 +0000547 * <p>Use in an NFC record with {@link #MIME_TYPE_PROVISIONING_NFC} that starts device owner
548 * provisioning via an NFC bump.
Sander Alewijnse1cc4ecc2014-06-23 19:56:52 +0100549 */
550 public static final String EXTRA_PROVISIONING_LOCAL_TIME
Esteban Talavera37f01842014-09-05 10:50:57 +0100551 = "android.app.extra.PROVISIONING_LOCAL_TIME";
Sander Alewijnse1cc4ecc2014-06-23 19:56:52 +0100552
553 /**
554 * A String extra holding the {@link java.util.Locale} that the device will be set to.
555 * Format: xx_yy, where xx is the language code, and yy the country code.
556 *
Sander Alewijnse8c411562014-11-12 18:03:11 +0000557 * <p>Use in an NFC record with {@link #MIME_TYPE_PROVISIONING_NFC} that starts device owner
558 * provisioning via an NFC bump.
Sander Alewijnse1cc4ecc2014-06-23 19:56:52 +0100559 */
560 public static final String EXTRA_PROVISIONING_LOCALE
Esteban Talavera37f01842014-09-05 10:50:57 +0100561 = "android.app.extra.PROVISIONING_LOCALE";
Sander Alewijnse1cc4ecc2014-06-23 19:56:52 +0100562
563 /**
564 * A String extra holding the ssid of the wifi network that should be used during nfc device
565 * owner provisioning for downloading the mobile device management application.
566 *
Sander Alewijnse8c411562014-11-12 18:03:11 +0000567 * <p>Use in an NFC record with {@link #MIME_TYPE_PROVISIONING_NFC} that starts device owner
568 * provisioning via an NFC bump.
Sander Alewijnse1cc4ecc2014-06-23 19:56:52 +0100569 */
570 public static final String EXTRA_PROVISIONING_WIFI_SSID
Esteban Talavera37f01842014-09-05 10:50:57 +0100571 = "android.app.extra.PROVISIONING_WIFI_SSID";
Sander Alewijnse1cc4ecc2014-06-23 19:56:52 +0100572
573 /**
574 * A boolean extra indicating whether the wifi network in {@link #EXTRA_PROVISIONING_WIFI_SSID}
575 * is hidden or not.
576 *
Sander Alewijnse8c411562014-11-12 18:03:11 +0000577 * <p>Use in an NFC record with {@link #MIME_TYPE_PROVISIONING_NFC} that starts device owner
578 * provisioning via an NFC bump.
Sander Alewijnse1cc4ecc2014-06-23 19:56:52 +0100579 */
580 public static final String EXTRA_PROVISIONING_WIFI_HIDDEN
Esteban Talavera37f01842014-09-05 10:50:57 +0100581 = "android.app.extra.PROVISIONING_WIFI_HIDDEN";
Sander Alewijnse1cc4ecc2014-06-23 19:56:52 +0100582
583 /**
584 * A String extra indicating the security type of the wifi network in
Mahaver Chopra76b08a92015-10-08 17:58:45 +0100585 * {@link #EXTRA_PROVISIONING_WIFI_SSID} and could be one of {@code NONE}, {@code WPA} or
586 * {@code WEP}.
Sander Alewijnse1cc4ecc2014-06-23 19:56:52 +0100587 *
Sander Alewijnse8c411562014-11-12 18:03:11 +0000588 * <p>Use in an NFC record with {@link #MIME_TYPE_PROVISIONING_NFC} that starts device owner
589 * provisioning via an NFC bump.
Sander Alewijnse1cc4ecc2014-06-23 19:56:52 +0100590 */
591 public static final String EXTRA_PROVISIONING_WIFI_SECURITY_TYPE
Esteban Talavera37f01842014-09-05 10:50:57 +0100592 = "android.app.extra.PROVISIONING_WIFI_SECURITY_TYPE";
Sander Alewijnse1cc4ecc2014-06-23 19:56:52 +0100593
594 /**
595 * A String extra holding the password of the wifi network in
596 * {@link #EXTRA_PROVISIONING_WIFI_SSID}.
597 *
Sander Alewijnse8c411562014-11-12 18:03:11 +0000598 * <p>Use in an NFC record with {@link #MIME_TYPE_PROVISIONING_NFC} that starts device owner
599 * provisioning via an NFC bump.
Sander Alewijnse1cc4ecc2014-06-23 19:56:52 +0100600 */
601 public static final String EXTRA_PROVISIONING_WIFI_PASSWORD
Esteban Talavera37f01842014-09-05 10:50:57 +0100602 = "android.app.extra.PROVISIONING_WIFI_PASSWORD";
Sander Alewijnse1cc4ecc2014-06-23 19:56:52 +0100603
604 /**
605 * A String extra holding the proxy host for the wifi network in
606 * {@link #EXTRA_PROVISIONING_WIFI_SSID}.
607 *
Sander Alewijnse8c411562014-11-12 18:03:11 +0000608 * <p>Use in an NFC record with {@link #MIME_TYPE_PROVISIONING_NFC} that starts device owner
609 * provisioning via an NFC bump.
Sander Alewijnse1cc4ecc2014-06-23 19:56:52 +0100610 */
611 public static final String EXTRA_PROVISIONING_WIFI_PROXY_HOST
Esteban Talavera37f01842014-09-05 10:50:57 +0100612 = "android.app.extra.PROVISIONING_WIFI_PROXY_HOST";
Sander Alewijnse1cc4ecc2014-06-23 19:56:52 +0100613
614 /**
615 * An int extra holding the proxy port for the wifi network in
616 * {@link #EXTRA_PROVISIONING_WIFI_SSID}.
617 *
Sander Alewijnse8c411562014-11-12 18:03:11 +0000618 * <p>Use in an NFC record with {@link #MIME_TYPE_PROVISIONING_NFC} that starts device owner
619 * provisioning via an NFC bump.
Sander Alewijnse1cc4ecc2014-06-23 19:56:52 +0100620 */
621 public static final String EXTRA_PROVISIONING_WIFI_PROXY_PORT
Esteban Talavera37f01842014-09-05 10:50:57 +0100622 = "android.app.extra.PROVISIONING_WIFI_PROXY_PORT";
Sander Alewijnse1cc4ecc2014-06-23 19:56:52 +0100623
624 /**
625 * A String extra holding the proxy bypass for the wifi network in
626 * {@link #EXTRA_PROVISIONING_WIFI_SSID}.
627 *
Sander Alewijnse8c411562014-11-12 18:03:11 +0000628 * <p>Use in an NFC record with {@link #MIME_TYPE_PROVISIONING_NFC} that starts device owner
629 * provisioning via an NFC bump.
Sander Alewijnse1cc4ecc2014-06-23 19:56:52 +0100630 */
631 public static final String EXTRA_PROVISIONING_WIFI_PROXY_BYPASS
Esteban Talavera37f01842014-09-05 10:50:57 +0100632 = "android.app.extra.PROVISIONING_WIFI_PROXY_BYPASS";
Sander Alewijnse1cc4ecc2014-06-23 19:56:52 +0100633
634 /**
635 * A String extra holding the proxy auto-config (PAC) URL for the wifi network in
636 * {@link #EXTRA_PROVISIONING_WIFI_SSID}.
637 *
Sander Alewijnse8c411562014-11-12 18:03:11 +0000638 * <p>Use in an NFC record with {@link #MIME_TYPE_PROVISIONING_NFC} that starts device owner
639 * provisioning via an NFC bump.
Sander Alewijnse1cc4ecc2014-06-23 19:56:52 +0100640 */
641 public static final String EXTRA_PROVISIONING_WIFI_PAC_URL
Esteban Talavera37f01842014-09-05 10:50:57 +0100642 = "android.app.extra.PROVISIONING_WIFI_PAC_URL";
Sander Alewijnse1cc4ecc2014-06-23 19:56:52 +0100643
644 /**
645 * A String extra holding a url that specifies the download location of the device admin
646 * package. When not provided it is assumed that the device admin package is already installed.
647 *
Sander Alewijnse8c411562014-11-12 18:03:11 +0000648 * <p>Use in an NFC record with {@link #MIME_TYPE_PROVISIONING_NFC} that starts device owner
649 * provisioning via an NFC bump.
Sander Alewijnse1cc4ecc2014-06-23 19:56:52 +0100650 */
651 public static final String EXTRA_PROVISIONING_DEVICE_ADMIN_PACKAGE_DOWNLOAD_LOCATION
Esteban Talavera37f01842014-09-05 10:50:57 +0100652 = "android.app.extra.PROVISIONING_DEVICE_ADMIN_PACKAGE_DOWNLOAD_LOCATION";
Sander Alewijnse1cc4ecc2014-06-23 19:56:52 +0100653
654 /**
Julia Reynoldsc1731742015-03-19 14:56:28 -0400655 * An int extra holding a minimum required version code for the device admin package. If the
656 * device admin is already installed on the device, it will only be re-downloaded from
657 * {@link #EXTRA_PROVISIONING_DEVICE_ADMIN_PACKAGE_DOWNLOAD_LOCATION} if the version of the
658 * installed package is less than this version code.
659 *
Craig Lafayette3cc72ba2015-06-26 11:51:04 -0400660 * <p>Use in an NFC record with {@link #MIME_TYPE_PROVISIONING_NFC} that starts device owner
Julia Reynoldsc1731742015-03-19 14:56:28 -0400661 * provisioning via an NFC bump.
662 */
663 public static final String EXTRA_PROVISIONING_DEVICE_ADMIN_MINIMUM_VERSION_CODE
664 = "android.app.extra.PROVISIONING_DEVICE_ADMIN_MINIMUM_VERSION_CODE";
665
666 /**
Sander Alewijnse681bce92014-07-24 16:46:26 +0100667 * A String extra holding a http cookie header which should be used in the http request to the
668 * url specified in {@link #EXTRA_PROVISIONING_DEVICE_ADMIN_PACKAGE_DOWNLOAD_LOCATION}.
669 *
Sander Alewijnse8c411562014-11-12 18:03:11 +0000670 * <p>Use in an NFC record with {@link #MIME_TYPE_PROVISIONING_NFC} that starts device owner
671 * provisioning via an NFC bump.
Sander Alewijnse681bce92014-07-24 16:46:26 +0100672 */
673 public static final String EXTRA_PROVISIONING_DEVICE_ADMIN_PACKAGE_DOWNLOAD_COOKIE_HEADER
Esteban Talavera37f01842014-09-05 10:50:57 +0100674 = "android.app.extra.PROVISIONING_DEVICE_ADMIN_PACKAGE_DOWNLOAD_COOKIE_HEADER";
Sander Alewijnse681bce92014-07-24 16:46:26 +0100675
676 /**
Rubin Xud92e7572015-05-18 17:01:13 +0100677 * A String extra holding the URL-safe base64 encoded SHA-256 or SHA-1 hash (see notes below) of
678 * the file at download location specified in
679 * {@link #EXTRA_PROVISIONING_DEVICE_ADMIN_PACKAGE_DOWNLOAD_LOCATION}.
Sander Alewijnsee4f878cb2015-04-14 10:49:17 +0100680 *
Benjamin Franzea956242016-03-21 15:45:56 +0000681 * <p>Either this extra or {@link #EXTRA_PROVISIONING_DEVICE_ADMIN_SIGNATURE_CHECKSUM} must be
682 * present. The provided checksum must match the checksum of the file at the download
Sander Alewijnsee4f878cb2015-04-14 10:49:17 +0100683 * location. If the checksum doesn't match an error will be shown to the user and the user will
684 * be asked to factory reset the device.
Sander Alewijnse1cc4ecc2014-06-23 19:56:52 +0100685 *
Sander Alewijnse8c411562014-11-12 18:03:11 +0000686 * <p>Use in an NFC record with {@link #MIME_TYPE_PROVISIONING_NFC} that starts device owner
687 * provisioning via an NFC bump.
Rubin Xud92e7572015-05-18 17:01:13 +0100688 *
689 * <p><strong>Note:</strong> for devices running {@link android.os.Build.VERSION_CODES#LOLLIPOP}
690 * and {@link android.os.Build.VERSION_CODES#LOLLIPOP_MR1} only SHA-1 hash is supported.
Dianne Hackborn0e3de6c2015-07-29 15:20:21 -0700691 * Starting from {@link android.os.Build.VERSION_CODES#M}, this parameter accepts SHA-256 in
Rubin Xud92e7572015-05-18 17:01:13 +0100692 * addition to SHA-1. Support for SHA-1 is likely to be removed in future OS releases.
Sander Alewijnse1cc4ecc2014-06-23 19:56:52 +0100693 */
694 public static final String EXTRA_PROVISIONING_DEVICE_ADMIN_PACKAGE_CHECKSUM
Esteban Talavera37f01842014-09-05 10:50:57 +0100695 = "android.app.extra.PROVISIONING_DEVICE_ADMIN_PACKAGE_CHECKSUM";
Sander Alewijnse1cc4ecc2014-06-23 19:56:52 +0100696
697 /**
Rubin Xud92e7572015-05-18 17:01:13 +0100698 * A String extra holding the URL-safe base64 encoded SHA-256 checksum of any signature of the
Sander Alewijnsee4f878cb2015-04-14 10:49:17 +0100699 * android package archive at the download location specified in {@link
700 * #EXTRA_PROVISIONING_DEVICE_ADMIN_PACKAGE_DOWNLOAD_LOCATION}.
701 *
Rubin Xu5c82d2c2015-06-02 09:29:46 +0100702 * <p>The signatures of an android package archive can be obtained using
Sander Alewijnsee4f878cb2015-04-14 10:49:17 +0100703 * {@link android.content.pm.PackageManager#getPackageArchiveInfo} with flag
704 * {@link android.content.pm.PackageManager#GET_SIGNATURES}.
705 *
Benjamin Franzea956242016-03-21 15:45:56 +0000706 * <p>Either this extra or {@link #EXTRA_PROVISIONING_DEVICE_ADMIN_PACKAGE_CHECKSUM} must be
707 * present. The provided checksum must match the checksum of any signature of the file at
Sander Alewijnsee4f878cb2015-04-14 10:49:17 +0100708 * the download location. If the checksum does not match an error will be shown to the user and
709 * the user will be asked to factory reset the device.
710 *
711 * <p>Use in an NFC record with {@link #MIME_TYPE_PROVISIONING_NFC} that starts device owner
712 * provisioning via an NFC bump.
713 */
Rubin Xu5c82d2c2015-06-02 09:29:46 +0100714 public static final String EXTRA_PROVISIONING_DEVICE_ADMIN_SIGNATURE_CHECKSUM
715 = "android.app.extra.PROVISIONING_DEVICE_ADMIN_SIGNATURE_CHECKSUM";
Sander Alewijnsee4f878cb2015-04-14 10:49:17 +0100716
717 /**
Alexandra Gherghinadb4bc572015-01-08 12:17:40 +0000718 * Broadcast Action: This broadcast is sent to indicate that provisioning of a managed profile
719 * has completed successfully.
720 *
721 * <p>The broadcast is limited to the primary profile, to the app specified in the provisioning
Nicolas Prevotebe2d992015-05-12 18:14:53 -0700722 * intent with action {@link #ACTION_PROVISION_MANAGED_PROFILE}.
Alexandra Gherghinadb4bc572015-01-08 12:17:40 +0000723 *
Ying Wang7f38aab2015-02-20 11:50:09 -0800724 * <p>This intent will contain the extra {@link #EXTRA_PROVISIONING_ACCOUNT_TO_MIGRATE} which
Alexandra Gherghinadb4bc572015-01-08 12:17:40 +0000725 * corresponds to the account requested to be migrated at provisioning time, if any.
726 */
727 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
728 public static final String ACTION_MANAGED_PROFILE_PROVISIONED
729 = "android.app.action.MANAGED_PROFILE_PROVISIONED";
730
731 /**
Benjamin Franzea956242016-03-21 15:45:56 +0000732 * A boolean extra indicating whether device encryption can be skipped as part of device owner
733 * or managed profile provisioning.
Julia Reynoldsa9ec70b2015-02-02 09:54:26 -0500734 *
Craig Lafayette3cc72ba2015-06-26 11:51:04 -0400735 * <p>Use in an NFC record with {@link #MIME_TYPE_PROVISIONING_NFC} or an intent with action
Nicolas Prevot64bf7b22015-04-29 14:43:49 +0100736 * {@link #ACTION_PROVISION_MANAGED_DEVICE} that starts device owner provisioning.
Benjamin Franzea956242016-03-21 15:45:56 +0000737 *
738 * <p>From {@link android.os.Build.VERSION_CODES#N} onwards, this is also supported for an
739 * intent with action {@link #ACTION_PROVISION_MANAGED_PROFILE}.
Julia Reynoldsa9ec70b2015-02-02 09:54:26 -0500740 */
741 public static final String EXTRA_PROVISIONING_SKIP_ENCRYPTION =
742 "android.app.extra.PROVISIONING_SKIP_ENCRYPTION";
743
744 /**
Nicolas Prevot8b7991c2015-11-12 17:40:12 +0000745 * A {@link Uri} extra pointing to a logo image. This image will be shown during the
746 * provisioning. If this extra is not passed, a default image will be shown.
747 * <h5>The following URI schemes are accepted:</h5>
748 * <ul>
749 * <li>content ({@link android.content.ContentResolver#SCHEME_CONTENT})</li>
750 * <li>android.resource ({@link android.content.ContentResolver#SCHEME_ANDROID_RESOURCE})</li>
751 * </ul>
752 *
753 * <p> It is the responsability of the caller to provide an image with a reasonable
754 * pixed density for the device.
755 *
756 * <p> If a content: URI is passed, the intent should have the flag
757 * {@link Intent#FLAG_GRANT_READ_URI_PERMISSION} and the uri should be added to the
758 * {@link android.content.ClipData} of the intent too.
759 *
760 * <p>Use in an intent with action {@link #ACTION_PROVISION_MANAGED_PROFILE} or
761 * {@link #ACTION_PROVISION_MANAGED_DEVICE}
762 */
763 public static final String EXTRA_PROVISIONING_LOGO_URI =
764 "android.app.extra.PROVISIONING_LOGO_URI";
765
766 /**
Alan Treadway94de8c82016-01-11 10:25:23 +0000767 * A boolean extra indicating if user setup should be skipped, for when provisioning is started
768 * during setup-wizard.
769 *
770 * <p>If unspecified, defaults to {@code true} to match the behavior in
771 * {@link android.os.Build.VERSION_CODES#M} and earlier.
772 *
Alan Treadway1a538d02016-01-18 16:42:30 +0000773 * <p>Use in an intent with action {@link #ACTION_PROVISION_MANAGED_DEVICE} or
774 * {@link #ACTION_PROVISION_MANAGED_USER}.
Alan Treadway94de8c82016-01-11 10:25:23 +0000775 *
776 * @hide
777 */
778 public static final String EXTRA_PROVISIONING_SKIP_USER_SETUP =
779 "android.app.extra.PROVISIONING_SKIP_USER_SETUP";
780
781 /**
Benjamin Franzea956242016-03-21 15:45:56 +0000782 * This MIME type is used for starting the device owner provisioning.
Sander Alewijnse1cc4ecc2014-06-23 19:56:52 +0100783 *
Craig Lafayette3cc72ba2015-06-26 11:51:04 -0400784 * <p>During device owner provisioning a device admin app is set as the owner of the device.
785 * A device owner has full control over the device. The device owner can not be modified by the
786 * user and the only way of resetting the device is if the device owner app calls a factory
787 * reset.
788 *
789 * <p> A typical use case would be a device that is owned by a company, but used by either an
790 * employee or client.
791 *
Benjamin Franzea956242016-03-21 15:45:56 +0000792 * <p> The NFC message must be sent to an unprovisioned device.
Sander Alewijnse1cc4ecc2014-06-23 19:56:52 +0100793 *
Sander Alewijnse8c411562014-11-12 18:03:11 +0000794 * <p>The NFC record must contain a serialized {@link java.util.Properties} object which
Sander Alewijnse1cc4ecc2014-06-23 19:56:52 +0100795 * contains the following properties:
796 * <ul>
Andrei Kapishnikov35e71f52015-03-16 17:24:04 -0400797 * <li>{@link #EXTRA_PROVISIONING_DEVICE_ADMIN_PACKAGE_NAME}</li>
798 * <li>{@link #EXTRA_PROVISIONING_DEVICE_ADMIN_PACKAGE_DOWNLOAD_LOCATION}, optional</li>
Sander Alewijnse681bce92014-07-24 16:46:26 +0100799 * <li>{@link #EXTRA_PROVISIONING_DEVICE_ADMIN_PACKAGE_DOWNLOAD_COOKIE_HEADER}, optional</li>
Andrei Kapishnikov35e71f52015-03-16 17:24:04 -0400800 * <li>{@link #EXTRA_PROVISIONING_DEVICE_ADMIN_PACKAGE_CHECKSUM}, optional</li>
Sander Alewijnse1cc4ecc2014-06-23 19:56:52 +0100801 * <li>{@link #EXTRA_PROVISIONING_LOCAL_TIME} (convert to String), optional</li>
802 * <li>{@link #EXTRA_PROVISIONING_TIME_ZONE}, optional</li>
803 * <li>{@link #EXTRA_PROVISIONING_LOCALE}, optional</li>
804 * <li>{@link #EXTRA_PROVISIONING_WIFI_SSID}, optional</li>
805 * <li>{@link #EXTRA_PROVISIONING_WIFI_HIDDEN} (convert to String), optional</li>
806 * <li>{@link #EXTRA_PROVISIONING_WIFI_SECURITY_TYPE}, optional</li>
807 * <li>{@link #EXTRA_PROVISIONING_WIFI_PASSWORD}, optional</li>
808 * <li>{@link #EXTRA_PROVISIONING_WIFI_PROXY_HOST}, optional</li>
809 * <li>{@link #EXTRA_PROVISIONING_WIFI_PROXY_PORT} (convert to String), optional</li>
810 * <li>{@link #EXTRA_PROVISIONING_WIFI_PROXY_BYPASS}, optional</li>
Rubin Xu41f2ccb92015-08-05 16:29:13 +0100811 * <li>{@link #EXTRA_PROVISIONING_WIFI_PAC_URL}, optional</li>
812 * <li>{@link #EXTRA_PROVISIONING_ADMIN_EXTRAS_BUNDLE}, optional, supported from
813 * {@link android.os.Build.VERSION_CODES#M} </li></ul>
Sander Alewijnse1cc4ecc2014-06-23 19:56:52 +0100814 *
Nicolas Prevot18440252015-03-09 14:07:17 +0000815 * <p>
Dianne Hackborn0e3de6c2015-07-29 15:20:21 -0700816 * As of {@link android.os.Build.VERSION_CODES#M}, the properties should contain
Andrei Kapishnikov35e71f52015-03-16 17:24:04 -0400817 * {@link #EXTRA_PROVISIONING_DEVICE_ADMIN_COMPONENT_NAME} instead of
818 * {@link #EXTRA_PROVISIONING_DEVICE_ADMIN_PACKAGE_NAME}, (although specifying only
819 * {@link #EXTRA_PROVISIONING_DEVICE_ADMIN_PACKAGE_NAME} is still supported).
Andrei Kapishnikov35e71f52015-03-16 17:24:04 -0400820 */
821 public static final String MIME_TYPE_PROVISIONING_NFC
822 = "application/com.android.managedprovisioning";
823
Sander Alewijnse1cc4ecc2014-06-23 19:56:52 +0100824 /**
Dianne Hackbornd6847842010-01-12 18:14:19 -0800825 * Activity action: ask the user to add a new device administrator to the system.
826 * The desired policy is the ComponentName of the policy in the
827 * {@link #EXTRA_DEVICE_ADMIN} extra field. This will invoke a UI to
828 * bring the user through adding the device administrator to the system (or
829 * allowing them to reject it).
Konstantin Lopyrev32558232010-05-20 16:18:05 -0700830 *
Dianne Hackborn8ea138c2010-01-26 18:01:04 -0800831 * <p>You can optionally include the {@link #EXTRA_ADD_EXPLANATION}
832 * field to provide the user with additional explanation (in addition
833 * to your component's description) about what is being added.
Andy Stadlerc25f70a2010-12-08 15:56:45 -0800834 *
835 * <p>If your administrator is already active, this will ordinarily return immediately (without
836 * user intervention). However, if your administrator has been updated and is requesting
837 * additional uses-policy flags, the user will be presented with the new list. New policies
838 * will not be available to the updated administrator until the user has accepted the new list.
Dianne Hackbornd6847842010-01-12 18:14:19 -0800839 */
840 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
841 public static final String ACTION_ADD_DEVICE_ADMIN
842 = "android.app.action.ADD_DEVICE_ADMIN";
Konstantin Lopyrev32558232010-05-20 16:18:05 -0700843
Dianne Hackbornd6847842010-01-12 18:14:19 -0800844 /**
Amith Yamasanibf3a9462014-07-28 14:26:42 -0700845 * @hide
846 * Activity action: ask the user to add a new device administrator as the profile owner
Amith Yamasani814e9872015-03-23 14:04:53 -0700847 * for this user. Only system apps can launch this intent.
Amith Yamasanibf3a9462014-07-28 14:26:42 -0700848 *
Amith Yamasani814e9872015-03-23 14:04:53 -0700849 * <p>The ComponentName of the profile owner admin is passed in the {@link #EXTRA_DEVICE_ADMIN}
850 * extra field. This will invoke a UI to bring the user through adding the profile owner admin
Amith Yamasanibf3a9462014-07-28 14:26:42 -0700851 * to remotely control restrictions on the user.
852 *
Makoto Onukic8a5a552015-11-19 14:29:12 -0800853 * <p>The intent must be invoked via {@link Activity#startActivityForResult} to receive the
Amith Yamasanibf3a9462014-07-28 14:26:42 -0700854 * result of whether or not the user approved the action. If approved, the result will
855 * be {@link Activity#RESULT_OK} and the component will be set as an active admin as well
856 * as a profile owner.
857 *
858 * <p>You can optionally include the {@link #EXTRA_ADD_EXPLANATION}
859 * field to provide the user with additional explanation (in addition
860 * to your component's description) about what is being added.
861 *
Amith Yamasani814e9872015-03-23 14:04:53 -0700862 * <p>If there is already a profile owner active or the caller is not a system app, the
863 * operation will return a failure result.
Amith Yamasanibf3a9462014-07-28 14:26:42 -0700864 */
865 @SystemApi
866 public static final String ACTION_SET_PROFILE_OWNER
867 = "android.app.action.SET_PROFILE_OWNER";
868
869 /**
870 * @hide
871 * Name of the profile owner admin that controls the user.
872 */
873 @SystemApi
874 public static final String EXTRA_PROFILE_OWNER_NAME
875 = "android.app.extra.PROFILE_OWNER_NAME";
876
877 /**
Nicolas Prevot00799002015-07-27 18:15:20 +0100878 * Broadcast action: send when any policy admin changes a policy.
Jim Miller284b62e2010-06-08 14:27:42 -0700879 * This is generally used to find out when a new policy is in effect.
Jim Miller3e5d3fd2011-09-02 17:30:35 -0700880 *
Jim Miller284b62e2010-06-08 14:27:42 -0700881 * @hide
882 */
883 public static final String ACTION_DEVICE_POLICY_MANAGER_STATE_CHANGED
884 = "android.app.action.DEVICE_POLICY_MANAGER_STATE_CHANGED";
885
886 /**
Nicolas Prevot00799002015-07-27 18:15:20 +0100887 * Broadcast action: sent when the device owner is set or changed.
888 *
889 * This broadcast is sent only to the primary user.
890 * @see #ACTION_PROVISION_MANAGED_DEVICE
891 */
892 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
893 public static final String ACTION_DEVICE_OWNER_CHANGED
894 = "android.app.action.DEVICE_OWNER_CHANGED";
895
896 /**
Dianne Hackbornd6847842010-01-12 18:14:19 -0800897 * The ComponentName of the administrator component.
898 *
899 * @see #ACTION_ADD_DEVICE_ADMIN
900 */
901 public static final String EXTRA_DEVICE_ADMIN = "android.app.extra.DEVICE_ADMIN";
Konstantin Lopyrev32558232010-05-20 16:18:05 -0700902
Dianne Hackbornd6847842010-01-12 18:14:19 -0800903 /**
Dianne Hackborn8ea138c2010-01-26 18:01:04 -0800904 * An optional CharSequence providing additional explanation for why the
905 * admin is being added.
906 *
907 * @see #ACTION_ADD_DEVICE_ADMIN
908 */
909 public static final String EXTRA_ADD_EXPLANATION = "android.app.extra.ADD_EXPLANATION";
Konstantin Lopyrev32558232010-05-20 16:18:05 -0700910
Dianne Hackborn8ea138c2010-01-26 18:01:04 -0800911 /**
Konstantin Lopyrev32558232010-05-20 16:18:05 -0700912 * Activity action: have the user enter a new password. This activity should
913 * be launched after using {@link #setPasswordQuality(ComponentName, int)},
914 * or {@link #setPasswordMinimumLength(ComponentName, int)} to have the user
915 * enter a new password that meets the current requirements. You can use
916 * {@link #isActivePasswordSufficient()} to determine whether you need to
917 * have the user select a new password in order to meet the current
918 * constraints. Upon being resumed from this activity, you can check the new
919 * password characteristics to see if they are sufficient.
Benjamin Franzc9921092016-01-08 17:17:44 +0000920 *
921 * If the intent is launched from within a managed profile with a profile
922 * owner built against {@link android.os.Build.VERSION_CODES#M} or before,
923 * this will trigger entering a new password for the parent of the profile.
924 * For all other cases it will trigger entering a new password for the user
925 * or profile it is launched from.
Esteban Talaverac1c83592016-02-17 17:56:15 +0000926 *
927 * @see #ACTION_SET_NEW_PARENT_PROFILE_PASSWORD
Dianne Hackbornd6847842010-01-12 18:14:19 -0800928 */
929 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
930 public static final String ACTION_SET_NEW_PASSWORD
931 = "android.app.action.SET_NEW_PASSWORD";
Amith Yamasanibf3a9462014-07-28 14:26:42 -0700932
Nicolas Prevot10fa67c2014-03-24 13:44:38 +0000933 /**
Benjamin Franzc9921092016-01-08 17:17:44 +0000934 * Activity action: have the user enter a new password for the parent profile.
935 * If the intent is launched from within a managed profile, this will trigger
936 * entering a new password for the parent of the profile. In all other cases
937 * the behaviour is identical to {@link #ACTION_SET_NEW_PASSWORD}.
938 */
939 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
940 public static final String ACTION_SET_NEW_PARENT_PROFILE_PASSWORD
941 = "android.app.action.SET_NEW_PARENT_PROFILE_PASSWORD";
942
943 /**
Nicolas Prevot2c1c5dd2015-01-12 12:32:56 +0000944 * Flag used by {@link #addCrossProfileIntentFilter} to allow activities in
945 * the parent profile to access intents sent from the managed profile.
946 * That is, when an app in the managed profile calls
947 * {@link Activity#startActivity(Intent)}, the intent can be resolved by a
948 * matching activity in the parent profile.
Nicolas Prevot10fa67c2014-03-24 13:44:38 +0000949 */
Nicolas Prevot86a96732014-09-08 12:13:05 +0100950 public static final int FLAG_PARENT_CAN_ACCESS_MANAGED = 0x0001;
Nicolas Prevot10fa67c2014-03-24 13:44:38 +0000951
952 /**
Nicolas Prevot2c1c5dd2015-01-12 12:32:56 +0000953 * Flag used by {@link #addCrossProfileIntentFilter} to allow activities in
954 * the managed profile to access intents sent from the parent profile.
955 * That is, when an app in the parent profile calls
956 * {@link Activity#startActivity(Intent)}, the intent can be resolved by a
957 * matching activity in the managed profile.
Nicolas Prevot10fa67c2014-03-24 13:44:38 +0000958 */
Nicolas Prevot86a96732014-09-08 12:13:05 +0100959 public static final int FLAG_MANAGED_CAN_ACCESS_PARENT = 0x0002;
Konstantin Lopyrev32558232010-05-20 16:18:05 -0700960
Dianne Hackbornd6847842010-01-12 18:14:19 -0800961 /**
Rubin Xu5faad8e2015-04-20 17:43:48 +0100962 * Broadcast action: notify that a new local system update policy has been set by the device
963 * owner. The new policy can be retrieved by {@link #getSystemUpdatePolicy()}.
Rubin Xu8027a4f2015-03-10 17:52:37 +0000964 */
965 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Rubin Xu5faad8e2015-04-20 17:43:48 +0100966 public static final String ACTION_SYSTEM_UPDATE_POLICY_CHANGED
967 = "android.app.action.SYSTEM_UPDATE_POLICY_CHANGED";
Rubin Xu8027a4f2015-03-10 17:52:37 +0000968
Amith Yamasanid49489b2015-04-28 14:00:26 -0700969 /**
970 * Permission policy to prompt user for new permission requests for runtime permissions.
971 * Already granted or denied permissions are not affected by this.
972 */
973 public static final int PERMISSION_POLICY_PROMPT = 0;
974
975 /**
976 * Permission policy to always grant new permission requests for runtime permissions.
977 * Already granted or denied permissions are not affected by this.
978 */
979 public static final int PERMISSION_POLICY_AUTO_GRANT = 1;
980
981 /**
982 * Permission policy to always deny new permission requests for runtime permissions.
983 * Already granted or denied permissions are not affected by this.
984 */
985 public static final int PERMISSION_POLICY_AUTO_DENY = 2;
986
Svet Ganovd8ecc5a2015-05-20 10:45:43 -0700987 /**
988 * Runtime permission state: The user can manage the permission
989 * through the UI.
990 */
991 public static final int PERMISSION_GRANT_STATE_DEFAULT = 0;
992
993 /**
994 * Runtime permission state: The permission is granted to the app
995 * and the user cannot manage the permission through the UI.
996 */
997 public static final int PERMISSION_GRANT_STATE_GRANTED = 1;
998
999 /**
1000 * Runtime permission state: The permission is denied to the app
1001 * and the user cannot manage the permission through the UI.
1002 */
1003 public static final int PERMISSION_GRANT_STATE_DENIED = 2;
Rubin Xu8027a4f2015-03-10 17:52:37 +00001004
1005 /**
Alan Treadwayafad8782016-01-19 15:15:08 +00001006 * No management for current user in-effect. This is the default.
1007 * @hide
1008 */
Benjamin Franzeed2a8e2016-02-19 14:19:05 +00001009 @SystemApi
Alan Treadwayafad8782016-01-19 15:15:08 +00001010 public static final int STATE_USER_UNMANAGED = 0;
1011
1012 /**
1013 * Management partially setup, user setup needs to be completed.
1014 * @hide
1015 */
Benjamin Franzeed2a8e2016-02-19 14:19:05 +00001016 @SystemApi
Alan Treadwayafad8782016-01-19 15:15:08 +00001017 public static final int STATE_USER_SETUP_INCOMPLETE = 1;
1018
1019 /**
1020 * Management partially setup, user setup completed.
1021 * @hide
1022 */
Benjamin Franzeed2a8e2016-02-19 14:19:05 +00001023 @SystemApi
Alan Treadwayafad8782016-01-19 15:15:08 +00001024 public static final int STATE_USER_SETUP_COMPLETE = 2;
1025
1026 /**
1027 * Management setup and active on current user.
1028 * @hide
1029 */
Benjamin Franzeed2a8e2016-02-19 14:19:05 +00001030 @SystemApi
Alan Treadwayafad8782016-01-19 15:15:08 +00001031 public static final int STATE_USER_SETUP_FINALIZED = 3;
1032
1033 /**
1034 * Management partially setup on a managed profile.
1035 * @hide
1036 */
Benjamin Franzeed2a8e2016-02-19 14:19:05 +00001037 @SystemApi
Alan Treadwayafad8782016-01-19 15:15:08 +00001038 public static final int STATE_USER_PROFILE_COMPLETE = 4;
1039
1040 /**
1041 * @hide
1042 */
1043 @IntDef({STATE_USER_UNMANAGED, STATE_USER_SETUP_INCOMPLETE, STATE_USER_SETUP_COMPLETE,
1044 STATE_USER_SETUP_FINALIZED, STATE_USER_PROFILE_COMPLETE})
1045 @Retention(RetentionPolicy.SOURCE)
1046 public @interface UserProvisioningState {}
1047
1048 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07001049 * Return true if the given administrator component is currently active (enabled) in the system.
1050 *
1051 * @param admin The administrator component to check for.
1052 * @return {@code true} if {@code admin} is currently enabled in the system, {@code false}
1053 * otherwise
Dianne Hackbornd6847842010-01-12 18:14:19 -08001054 */
Robin Lee25e26452015-06-02 09:56:29 -07001055 public boolean isAdminActive(@NonNull ComponentName admin) {
Makoto Onukicc4bbeb2015-09-17 10:28:24 -07001056 return isAdminActiveAsUser(admin, myUserId());
Zoltan Szatmary-Ban3f1ddf82014-07-02 16:42:05 +01001057 }
1058
1059 /**
1060 * @see #isAdminActive(ComponentName)
1061 * @hide
1062 */
Robin Lee25e26452015-06-02 09:56:29 -07001063 public boolean isAdminActiveAsUser(@NonNull ComponentName admin, int userId) {
Dianne Hackbornd6847842010-01-12 18:14:19 -08001064 if (mService != null) {
1065 try {
Robin Lee25e26452015-06-02 09:56:29 -07001066 return mService.isAdminActive(admin, userId);
Dianne Hackbornd6847842010-01-12 18:14:19 -08001067 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07001068 throw e.rethrowFromSystemServer();
Dianne Hackbornd6847842010-01-12 18:14:19 -08001069 }
1070 }
1071 return false;
1072 }
Fyodor Kupolov96fb9322014-12-01 15:08:09 -08001073 /**
1074 * Return true if the given administrator component is currently being removed
1075 * for the user.
1076 * @hide
1077 */
Robin Lee25e26452015-06-02 09:56:29 -07001078 public boolean isRemovingAdmin(@NonNull ComponentName admin, int userId) {
Fyodor Kupolov96fb9322014-12-01 15:08:09 -08001079 if (mService != null) {
1080 try {
Robin Lee25e26452015-06-02 09:56:29 -07001081 return mService.isRemovingAdmin(admin, userId);
Fyodor Kupolov96fb9322014-12-01 15:08:09 -08001082 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07001083 throw e.rethrowFromSystemServer();
Fyodor Kupolov96fb9322014-12-01 15:08:09 -08001084 }
1085 }
1086 return false;
1087 }
1088
Konstantin Lopyrev32558232010-05-20 16:18:05 -07001089
Dianne Hackbornd6847842010-01-12 18:14:19 -08001090 /**
Robin Lee25e26452015-06-02 09:56:29 -07001091 * Return a list of all currently active device administrators' component
1092 * names. If there are no administrators {@code null} may be
Dianne Hackbornd47c6ed2010-01-27 16:21:20 -08001093 * returned.
1094 */
1095 public List<ComponentName> getActiveAdmins() {
Benjamin Franzbc33c822016-04-15 08:57:52 +01001096 throwIfParentInstance("getActiveAdmins");
Makoto Onukicc4bbeb2015-09-17 10:28:24 -07001097 return getActiveAdminsAsUser(myUserId());
Zoltan Szatmary-Ban3f1ddf82014-07-02 16:42:05 +01001098 }
1099
1100 /**
1101 * @see #getActiveAdmins()
1102 * @hide
1103 */
1104 public List<ComponentName> getActiveAdminsAsUser(int userId) {
Dianne Hackbornd47c6ed2010-01-27 16:21:20 -08001105 if (mService != null) {
1106 try {
Zoltan Szatmary-Ban3f1ddf82014-07-02 16:42:05 +01001107 return mService.getActiveAdmins(userId);
Dianne Hackbornd47c6ed2010-01-27 16:21:20 -08001108 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07001109 throw e.rethrowFromSystemServer();
Dianne Hackbornd47c6ed2010-01-27 16:21:20 -08001110 }
1111 }
1112 return null;
1113 }
Konstantin Lopyrev32558232010-05-20 16:18:05 -07001114
Dianne Hackbornd47c6ed2010-01-27 16:21:20 -08001115 /**
Amith Yamasani599dd7c2012-09-14 23:20:08 -07001116 * Used by package administration code to determine if a package can be stopped
1117 * or uninstalled.
Dianne Hackborn21f1bd12010-02-19 17:02:21 -08001118 * @hide
1119 */
1120 public boolean packageHasActiveAdmins(String packageName) {
Amith Yamasanica5d6d22016-02-16 13:58:46 -08001121 return packageHasActiveAdmins(packageName, myUserId());
1122 }
1123
1124 /**
1125 * Used by package administration code to determine if a package can be stopped
1126 * or uninstalled.
1127 * @hide
1128 */
1129 public boolean packageHasActiveAdmins(String packageName, int userId) {
Dianne Hackborn21f1bd12010-02-19 17:02:21 -08001130 if (mService != null) {
1131 try {
Amith Yamasanica5d6d22016-02-16 13:58:46 -08001132 return mService.packageHasActiveAdmins(packageName, userId);
Dianne Hackborn21f1bd12010-02-19 17:02:21 -08001133 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07001134 throw e.rethrowFromSystemServer();
Dianne Hackborn21f1bd12010-02-19 17:02:21 -08001135 }
1136 }
1137 return false;
1138 }
Konstantin Lopyrev32558232010-05-20 16:18:05 -07001139
Dianne Hackborn21f1bd12010-02-19 17:02:21 -08001140 /**
Dianne Hackbornd6847842010-01-12 18:14:19 -08001141 * Remove a current administration component. This can only be called
1142 * by the application that owns the administration component; if you
1143 * try to remove someone else's component, a security exception will be
1144 * thrown.
Esteban Talavera552a5612016-02-19 17:02:24 +00001145 *
1146 * <p>Note that the operation is not synchronous and the admin might still be active (as
1147 * indicated by {@link #getActiveAdmins()}) by the time this method returns.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07001148 *
1149 * @param admin The administration compononent to remove.
1150 * @throws SecurityException if the caller is not in the owner application of {@code admin}.
Dianne Hackbornd6847842010-01-12 18:14:19 -08001151 */
Robin Lee25e26452015-06-02 09:56:29 -07001152 public void removeActiveAdmin(@NonNull ComponentName admin) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01001153 throwIfParentInstance("removeActiveAdmin");
Dianne Hackbornd6847842010-01-12 18:14:19 -08001154 if (mService != null) {
1155 try {
Makoto Onukicc4bbeb2015-09-17 10:28:24 -07001156 mService.removeActiveAdmin(admin, myUserId());
Dianne Hackbornd6847842010-01-12 18:14:19 -08001157 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07001158 throw e.rethrowFromSystemServer();
Dianne Hackbornd6847842010-01-12 18:14:19 -08001159 }
1160 }
1161 }
Konstantin Lopyrev32558232010-05-20 16:18:05 -07001162
Dianne Hackbornd6847842010-01-12 18:14:19 -08001163 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07001164 * Returns true if an administrator has been granted a particular device policy. This can be
1165 * used to check whether the administrator was activated under an earlier set of policies, but
1166 * requires additional policies after an upgrade.
Andy Stadlerc25f70a2010-12-08 15:56:45 -08001167 *
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07001168 * @param admin Which {@link DeviceAdminReceiver} this request is associated with. Must be an
1169 * active administrator, or an exception will be thrown.
Andy Stadlerc25f70a2010-12-08 15:56:45 -08001170 * @param usesPolicy Which uses-policy to check, as defined in {@link DeviceAdminInfo}.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07001171 * @throws SecurityException if {@code admin} is not an active administrator.
Andy Stadlerc25f70a2010-12-08 15:56:45 -08001172 */
Robin Lee25e26452015-06-02 09:56:29 -07001173 public boolean hasGrantedPolicy(@NonNull ComponentName admin, int usesPolicy) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01001174 throwIfParentInstance("hasGrantedPolicy");
Andy Stadlerc25f70a2010-12-08 15:56:45 -08001175 if (mService != null) {
1176 try {
Makoto Onukicc4bbeb2015-09-17 10:28:24 -07001177 return mService.hasGrantedPolicy(admin, usesPolicy, myUserId());
Andy Stadlerc25f70a2010-12-08 15:56:45 -08001178 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07001179 throw e.rethrowFromSystemServer();
Andy Stadlerc25f70a2010-12-08 15:56:45 -08001180 }
1181 }
1182 return false;
1183 }
1184
1185 /**
Clara Bayarria1771112015-12-18 16:29:18 +00001186 * Returns true if the Profile Challenge is available to use for the given profile user.
1187 *
1188 * @hide
1189 */
1190 public boolean isSeparateProfileChallengeAllowed(int userHandle) {
1191 if (mService != null) {
1192 try {
1193 return mService.isSeparateProfileChallengeAllowed(userHandle);
1194 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07001195 throw e.rethrowFromSystemServer();
Clara Bayarria1771112015-12-18 16:29:18 +00001196 }
1197 }
1198 return false;
1199 }
1200
1201 /**
Dianne Hackborn9327f4f2010-01-29 10:38:29 -08001202 * Constant for {@link #setPasswordQuality}: the policy has no requirements
1203 * for the password. Note that quality constants are ordered so that higher
Dianne Hackborndf83afa2010-01-20 13:37:26 -08001204 * values are more restrictive.
Dianne Hackbornd6847842010-01-12 18:14:19 -08001205 */
Dianne Hackborn9327f4f2010-01-29 10:38:29 -08001206 public static final int PASSWORD_QUALITY_UNSPECIFIED = 0;
Konstantin Lopyrev32558232010-05-20 16:18:05 -07001207
Dianne Hackbornd6847842010-01-12 18:14:19 -08001208 /**
Jim Miller3e5d3fd2011-09-02 17:30:35 -07001209 * Constant for {@link #setPasswordQuality}: the policy allows for low-security biometric
1210 * recognition technology. This implies technologies that can recognize the identity of
1211 * an individual to about a 3 digit PIN (false detection is less than 1 in 1,000).
1212 * Note that quality constants are ordered so that higher values are more restrictive.
1213 */
1214 public static final int PASSWORD_QUALITY_BIOMETRIC_WEAK = 0x8000;
1215
1216 /**
Dianne Hackborn9327f4f2010-01-29 10:38:29 -08001217 * Constant for {@link #setPasswordQuality}: the policy requires some kind
Benjamin Franzc6a96532015-06-16 11:23:38 +01001218 * of password or pattern, but doesn't care what it is. Note that quality constants
Dianne Hackborndf83afa2010-01-20 13:37:26 -08001219 * are ordered so that higher values are more restrictive.
Dianne Hackbornd6847842010-01-12 18:14:19 -08001220 */
Dianne Hackborn9327f4f2010-01-29 10:38:29 -08001221 public static final int PASSWORD_QUALITY_SOMETHING = 0x10000;
Konstantin Lopyrev32558232010-05-20 16:18:05 -07001222
Dianne Hackborndf83afa2010-01-20 13:37:26 -08001223 /**
Dianne Hackborn9327f4f2010-01-29 10:38:29 -08001224 * Constant for {@link #setPasswordQuality}: the user must have entered a
1225 * password containing at least numeric characters. Note that quality
1226 * constants are ordered so that higher values are more restrictive.
Dianne Hackborndf83afa2010-01-20 13:37:26 -08001227 */
Dianne Hackborn9327f4f2010-01-29 10:38:29 -08001228 public static final int PASSWORD_QUALITY_NUMERIC = 0x20000;
Konstantin Lopyrev32558232010-05-20 16:18:05 -07001229
Dianne Hackbornd6847842010-01-12 18:14:19 -08001230 /**
Dianne Hackborn9327f4f2010-01-29 10:38:29 -08001231 * Constant for {@link #setPasswordQuality}: the user must have entered a
Jim Miller85516d02014-01-31 17:08:37 -08001232 * password containing at least numeric characters with no repeating (4444)
1233 * or ordered (1234, 4321, 2468) sequences. Note that quality
1234 * constants are ordered so that higher values are more restrictive.
1235 */
1236 public static final int PASSWORD_QUALITY_NUMERIC_COMPLEX = 0x30000;
1237
1238 /**
1239 * Constant for {@link #setPasswordQuality}: the user must have entered a
Dianne Hackborn85f2c9c2010-03-22 11:12:48 -07001240 * password containing at least alphabetic (or other symbol) characters.
1241 * Note that quality constants are ordered so that higher values are more
1242 * restrictive.
1243 */
1244 public static final int PASSWORD_QUALITY_ALPHABETIC = 0x40000;
Konstantin Lopyrev32558232010-05-20 16:18:05 -07001245
Dianne Hackborn85f2c9c2010-03-22 11:12:48 -07001246 /**
1247 * Constant for {@link #setPasswordQuality}: the user must have entered a
Dianne Hackborn9327f4f2010-01-29 10:38:29 -08001248 * password containing at least <em>both></em> numeric <em>and</em>
Dianne Hackborn85f2c9c2010-03-22 11:12:48 -07001249 * alphabetic (or other symbol) characters. Note that quality constants are
Dianne Hackborn9327f4f2010-01-29 10:38:29 -08001250 * ordered so that higher values are more restrictive.
Dianne Hackbornd6847842010-01-12 18:14:19 -08001251 */
Dianne Hackborn85f2c9c2010-03-22 11:12:48 -07001252 public static final int PASSWORD_QUALITY_ALPHANUMERIC = 0x50000;
Konstantin Lopyrev32558232010-05-20 16:18:05 -07001253
Dianne Hackbornd6847842010-01-12 18:14:19 -08001254 /**
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001255 * Constant for {@link #setPasswordQuality}: the user must have entered a
Konstantin Lopyrevc8577402010-06-04 17:15:02 -07001256 * password containing at least a letter, a numerical digit and a special
1257 * symbol, by default. With this password quality, passwords can be
1258 * restricted to contain various sets of characters, like at least an
1259 * uppercase letter, etc. These are specified using various methods,
1260 * like {@link #setPasswordMinimumLowerCase(ComponentName, int)}. Note
1261 * that quality constants are ordered so that higher values are more
1262 * restrictive.
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001263 */
1264 public static final int PASSWORD_QUALITY_COMPLEX = 0x60000;
1265
1266 /**
Oleksandr Peletskyi0fdcd3d2016-01-13 16:49:56 +01001267 * Constant for {@link #setPasswordQuality}: the user is not allowed to
1268 * modify password. In case this password quality is set, the password is
1269 * managed by a profile owner. The profile owner can set any password,
1270 * as if {@link #PASSWORD_QUALITY_UNSPECIFIED} is used. Note
1271 * that quality constants are ordered so that higher values are more
1272 * restrictive. The value of {@link #PASSWORD_QUALITY_MANAGED} is
1273 * the highest.
1274 * @hide
1275 */
1276 public static final int PASSWORD_QUALITY_MANAGED = 0x80000;
1277
1278 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07001279 * Called by an application that is administering the device to set the password restrictions it
1280 * is imposing. After setting this, the user will not be able to enter a new password that is
1281 * not at least as restrictive as what has been set. Note that the current password will remain
1282 * until the user has set a new one, so the change does not take place immediately. To prompt
1283 * the user for a new password, use {@link #ACTION_SET_NEW_PASSWORD} or
Esteban Talaverac1c83592016-02-17 17:56:15 +00001284 * {@link #ACTION_SET_NEW_PARENT_PROFILE_PASSWORD} after calling this method.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07001285 * <p>
1286 * Quality constants are ordered so that higher values are more restrictive; thus the highest
1287 * requested quality constant (between the policy set here, the user's preference, and any other
1288 * considerations) is the one that is in effect.
1289 * <p>
1290 * The calling device admin must have requested
1291 * {@link DeviceAdminInfo#USES_POLICY_LIMIT_PASSWORD} to be able to call this method; if it has
1292 * not, a security exception will be thrown.
1293 * <p>
1294 * This method can be called on the {@link DevicePolicyManager} instance returned by
1295 * {@link #getParentProfileInstance(ComponentName)} in order to set restrictions on the parent
1296 * profile.
Esteban Talaverac1c83592016-02-17 17:56:15 +00001297 *
Dianne Hackbornef6b22f2010-02-16 20:38:49 -08001298 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07001299 * @param quality The new desired quality. One of {@link #PASSWORD_QUALITY_UNSPECIFIED},
1300 * {@link #PASSWORD_QUALITY_SOMETHING}, {@link #PASSWORD_QUALITY_NUMERIC},
1301 * {@link #PASSWORD_QUALITY_NUMERIC_COMPLEX}, {@link #PASSWORD_QUALITY_ALPHABETIC},
1302 * {@link #PASSWORD_QUALITY_ALPHANUMERIC} or {@link #PASSWORD_QUALITY_COMPLEX}.
1303 * @throws SecurityException if {@code admin} is not an active administrator or if {@code admin}
1304 * does not use {@link DeviceAdminInfo#USES_POLICY_LIMIT_PASSWORD}
Dianne Hackbornd6847842010-01-12 18:14:19 -08001305 */
Robin Lee25e26452015-06-02 09:56:29 -07001306 public void setPasswordQuality(@NonNull ComponentName admin, int quality) {
Dianne Hackbornd6847842010-01-12 18:14:19 -08001307 if (mService != null) {
1308 try {
Clara Bayarri3e826ef2015-12-14 17:51:22 +00001309 mService.setPasswordQuality(admin, quality, mParentInstance);
Dianne Hackbornd6847842010-01-12 18:14:19 -08001310 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07001311 throw e.rethrowFromSystemServer();
Dianne Hackbornd6847842010-01-12 18:14:19 -08001312 }
1313 }
1314 }
Konstantin Lopyrev32558232010-05-20 16:18:05 -07001315
Dianne Hackbornd6847842010-01-12 18:14:19 -08001316 /**
Esteban Talaverac1c83592016-02-17 17:56:15 +00001317 * Retrieve the current minimum password quality for a particular admin or all admins that set
1318 * retrictions on this user and its participating profiles. Restrictions on profiles that have
1319 * a separate challenge are not taken into account.
1320 *
1321 * <p>This method can be called on the {@link DevicePolicyManager} instance
1322 * returned by {@link #getParentProfileInstance(ComponentName)} in order to retrieve
1323 * restrictions on the parent profile.
1324 *
Robin Lee25e26452015-06-02 09:56:29 -07001325 * @param admin The name of the admin component to check, or {@code null} to aggregate
Dianne Hackborn254cb442010-01-27 19:23:59 -08001326 * all admins.
Dianne Hackbornd6847842010-01-12 18:14:19 -08001327 */
Robin Lee25e26452015-06-02 09:56:29 -07001328 public int getPasswordQuality(@Nullable ComponentName admin) {
Makoto Onukicc4bbeb2015-09-17 10:28:24 -07001329 return getPasswordQuality(admin, myUserId());
Amith Yamasani599dd7c2012-09-14 23:20:08 -07001330 }
1331
1332 /** @hide per-user version */
Robin Lee25e26452015-06-02 09:56:29 -07001333 public int getPasswordQuality(@Nullable ComponentName admin, int userHandle) {
Dianne Hackbornd6847842010-01-12 18:14:19 -08001334 if (mService != null) {
1335 try {
Clara Bayarri3e826ef2015-12-14 17:51:22 +00001336 return mService.getPasswordQuality(admin, userHandle, mParentInstance);
Dianne Hackbornd6847842010-01-12 18:14:19 -08001337 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07001338 throw e.rethrowFromSystemServer();
Dianne Hackbornd6847842010-01-12 18:14:19 -08001339 }
1340 }
Dianne Hackborn9327f4f2010-01-29 10:38:29 -08001341 return PASSWORD_QUALITY_UNSPECIFIED;
Dianne Hackbornd6847842010-01-12 18:14:19 -08001342 }
Konstantin Lopyrev32558232010-05-20 16:18:05 -07001343
Dianne Hackbornd6847842010-01-12 18:14:19 -08001344 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07001345 * Called by an application that is administering the device to set the minimum allowed password
1346 * length. After setting this, the user will not be able to enter a new password that is not at
1347 * least as restrictive as what has been set. Note that the current password will remain until
1348 * the user has set a new one, so the change does not take place immediately. To prompt the user
1349 * for a new password, use {@link #ACTION_SET_NEW_PASSWORD} or
1350 * {@link #ACTION_SET_NEW_PARENT_PROFILE_PASSWORD} after setting this value. This constraint is
1351 * only imposed if the administrator has also requested either {@link #PASSWORD_QUALITY_NUMERIC}
1352 * , {@link #PASSWORD_QUALITY_NUMERIC_COMPLEX}, {@link #PASSWORD_QUALITY_ALPHABETIC},
1353 * {@link #PASSWORD_QUALITY_ALPHANUMERIC}, or {@link #PASSWORD_QUALITY_COMPLEX} with
1354 * {@link #setPasswordQuality}.
1355 * <p>
1356 * The calling device admin must have requested
1357 * {@link DeviceAdminInfo#USES_POLICY_LIMIT_PASSWORD} to be able to call this method; if it has
1358 * not, a security exception will be thrown.
1359 * <p>
1360 * This method can be called on the {@link DevicePolicyManager} instance returned by
1361 * {@link #getParentProfileInstance(ComponentName)} in order to set restrictions on the parent
1362 * profile.
Esteban Talaverac1c83592016-02-17 17:56:15 +00001363 *
Dianne Hackbornef6b22f2010-02-16 20:38:49 -08001364 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07001365 * @param length The new desired minimum password length. A value of 0 means there is no
1366 * restriction.
1367 * @throws SecurityException if {@code admin} is not an active administrator or {@code admin}
1368 * does not use {@link DeviceAdminInfo#USES_POLICY_LIMIT_PASSWORD}
Dianne Hackbornd6847842010-01-12 18:14:19 -08001369 */
Robin Lee25e26452015-06-02 09:56:29 -07001370 public void setPasswordMinimumLength(@NonNull ComponentName admin, int length) {
Dianne Hackbornd6847842010-01-12 18:14:19 -08001371 if (mService != null) {
1372 try {
Esteban Talavera62399912016-01-11 15:37:55 +00001373 mService.setPasswordMinimumLength(admin, length, mParentInstance);
Dianne Hackbornd6847842010-01-12 18:14:19 -08001374 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07001375 throw e.rethrowFromSystemServer();
Dianne Hackbornd6847842010-01-12 18:14:19 -08001376 }
1377 }
1378 }
Konstantin Lopyrev32558232010-05-20 16:18:05 -07001379
Dianne Hackbornd6847842010-01-12 18:14:19 -08001380 /**
Esteban Talaverac1c83592016-02-17 17:56:15 +00001381 * Retrieve the current minimum password length for a particular admin or all admins that set
1382 * retrictions on this user and its participating profiles. Restrictions on profiles that have
1383 * a separate challenge are not taken into account.
1384 *
1385 * <p>This method can be called on the {@link DevicePolicyManager} instance
1386 * returned by {@link #getParentProfileInstance(ComponentName)} in order to retrieve
1387 * restrictions on the parent profile.
1388 *
Jessica Hummel91da58d2014-04-10 17:39:43 +01001389 * user and its profiles or a particular one.
Robin Lee25e26452015-06-02 09:56:29 -07001390 * @param admin The name of the admin component to check, or {@code null} to aggregate
Dianne Hackborn254cb442010-01-27 19:23:59 -08001391 * all admins.
Dianne Hackbornd6847842010-01-12 18:14:19 -08001392 */
Robin Lee25e26452015-06-02 09:56:29 -07001393 public int getPasswordMinimumLength(@Nullable ComponentName admin) {
Makoto Onukicc4bbeb2015-09-17 10:28:24 -07001394 return getPasswordMinimumLength(admin, myUserId());
Amith Yamasani599dd7c2012-09-14 23:20:08 -07001395 }
1396
1397 /** @hide per-user version */
Robin Lee25e26452015-06-02 09:56:29 -07001398 public int getPasswordMinimumLength(@Nullable ComponentName admin, int userHandle) {
Dianne Hackbornd6847842010-01-12 18:14:19 -08001399 if (mService != null) {
1400 try {
Esteban Talavera62399912016-01-11 15:37:55 +00001401 return mService.getPasswordMinimumLength(admin, userHandle, mParentInstance);
Dianne Hackbornd6847842010-01-12 18:14:19 -08001402 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07001403 throw e.rethrowFromSystemServer();
Dianne Hackbornd6847842010-01-12 18:14:19 -08001404 }
1405 }
1406 return 0;
1407 }
Konstantin Lopyrev32558232010-05-20 16:18:05 -07001408
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001409 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07001410 * Called by an application that is administering the device to set the minimum number of upper
1411 * case letters required in the password. After setting this, the user will not be able to enter
1412 * a new password that is not at least as restrictive as what has been set. Note that the
1413 * current password will remain until the user has set a new one, so the change does not take
1414 * place immediately. To prompt the user for a new password, use
1415 * {@link #ACTION_SET_NEW_PASSWORD} or {@link #ACTION_SET_NEW_PARENT_PROFILE_PASSWORD} after
1416 * setting this value. This constraint is only imposed if the administrator has also requested
1417 * {@link #PASSWORD_QUALITY_COMPLEX} with {@link #setPasswordQuality}. The default value is 0.
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001418 * <p>
1419 * The calling device admin must have requested
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07001420 * {@link DeviceAdminInfo#USES_POLICY_LIMIT_PASSWORD} to be able to call this method; if it has
1421 * not, a security exception will be thrown.
1422 * <p>
1423 * This method can be called on the {@link DevicePolicyManager} instance returned by
1424 * {@link #getParentProfileInstance(ComponentName)} in order to set restrictions on the parent
1425 * profile.
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001426 *
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07001427 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
1428 * @param length The new desired minimum number of upper case letters required in the password.
1429 * A value of 0 means there is no restriction.
1430 * @throws SecurityException if {@code admin} is not an active administrator or {@code admin}
1431 * does not use {@link DeviceAdminInfo#USES_POLICY_LIMIT_PASSWORD}
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001432 */
Robin Lee25e26452015-06-02 09:56:29 -07001433 public void setPasswordMinimumUpperCase(@NonNull ComponentName admin, int length) {
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001434 if (mService != null) {
1435 try {
Esteban Talavera62399912016-01-11 15:37:55 +00001436 mService.setPasswordMinimumUpperCase(admin, length, mParentInstance);
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001437 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07001438 throw e.rethrowFromSystemServer();
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001439 }
1440 }
1441 }
1442
1443 /**
Esteban Talaverac1c83592016-02-17 17:56:15 +00001444 * Retrieve the current number of upper case letters required in the password
1445 * for a particular admin or all admins that set retrictions on this user and
1446 * its participating profiles. Restrictions on profiles that have a separate challenge
1447 * are not taken into account.
Jessica Hummel91da58d2014-04-10 17:39:43 +01001448 * This is the same value as set by
Esteban Talaverac1c83592016-02-17 17:56:15 +00001449 * {@link #setPasswordMinimumUpperCase(ComponentName, int)}
Konstantin Lopyrevc8577402010-06-04 17:15:02 -07001450 * and only applies when the password quality is
1451 * {@link #PASSWORD_QUALITY_COMPLEX}.
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001452 *
Esteban Talaverac1c83592016-02-17 17:56:15 +00001453 * <p>This method can be called on the {@link DevicePolicyManager} instance
1454 * returned by {@link #getParentProfileInstance(ComponentName)} in order to retrieve
1455 * restrictions on the parent profile.
1456 *
Robin Lee25e26452015-06-02 09:56:29 -07001457 * @param admin The name of the admin component to check, or {@code null} to
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001458 * aggregate all admins.
1459 * @return The minimum number of upper case letters required in the
1460 * password.
1461 */
Robin Lee25e26452015-06-02 09:56:29 -07001462 public int getPasswordMinimumUpperCase(@Nullable ComponentName admin) {
Makoto Onukicc4bbeb2015-09-17 10:28:24 -07001463 return getPasswordMinimumUpperCase(admin, myUserId());
Amith Yamasani599dd7c2012-09-14 23:20:08 -07001464 }
1465
1466 /** @hide per-user version */
Robin Lee25e26452015-06-02 09:56:29 -07001467 public int getPasswordMinimumUpperCase(@Nullable ComponentName admin, int userHandle) {
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001468 if (mService != null) {
1469 try {
Esteban Talavera62399912016-01-11 15:37:55 +00001470 return mService.getPasswordMinimumUpperCase(admin, userHandle, mParentInstance);
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001471 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07001472 throw e.rethrowFromSystemServer();
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001473 }
1474 }
1475 return 0;
1476 }
1477
1478 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07001479 * Called by an application that is administering the device to set the minimum number of lower
1480 * case letters required in the password. After setting this, the user will not be able to enter
1481 * a new password that is not at least as restrictive as what has been set. Note that the
1482 * current password will remain until the user has set a new one, so the change does not take
1483 * place immediately. To prompt the user for a new password, use
1484 * {@link #ACTION_SET_NEW_PASSWORD} or {@link #ACTION_SET_NEW_PARENT_PROFILE_PASSWORD} after
1485 * setting this value. This constraint is only imposed if the administrator has also requested
1486 * {@link #PASSWORD_QUALITY_COMPLEX} with {@link #setPasswordQuality}. The default value is 0.
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001487 * <p>
1488 * The calling device admin must have requested
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07001489 * {@link DeviceAdminInfo#USES_POLICY_LIMIT_PASSWORD} to be able to call this method; if it has
1490 * not, a security exception will be thrown.
1491 * <p>
1492 * This method can be called on the {@link DevicePolicyManager} instance returned by
1493 * {@link #getParentProfileInstance(ComponentName)} in order to set restrictions on the parent
1494 * profile.
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001495 *
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07001496 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
1497 * @param length The new desired minimum number of lower case letters required in the password.
1498 * A value of 0 means there is no restriction.
1499 * @throws SecurityException if {@code admin} is not an active administrator or {@code admin}
1500 * does not use {@link DeviceAdminInfo#USES_POLICY_LIMIT_PASSWORD}
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001501 */
Robin Lee25e26452015-06-02 09:56:29 -07001502 public void setPasswordMinimumLowerCase(@NonNull ComponentName admin, int length) {
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001503 if (mService != null) {
1504 try {
Esteban Talavera62399912016-01-11 15:37:55 +00001505 mService.setPasswordMinimumLowerCase(admin, length, mParentInstance);
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001506 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07001507 throw e.rethrowFromSystemServer();
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001508 }
1509 }
1510 }
1511
1512 /**
Esteban Talaverac1c83592016-02-17 17:56:15 +00001513 * Retrieve the current number of lower case letters required in the password
1514 * for a particular admin or all admins that set retrictions on this user
1515 * and its participating profiles. Restrictions on profiles that have
1516 * a separate challenge are not taken into account.
Jessica Hummel91da58d2014-04-10 17:39:43 +01001517 * This is the same value as set by
Esteban Talaverac1c83592016-02-17 17:56:15 +00001518 * {@link #setPasswordMinimumLowerCase(ComponentName, int)}
Konstantin Lopyrevc8577402010-06-04 17:15:02 -07001519 * and only applies when the password quality is
1520 * {@link #PASSWORD_QUALITY_COMPLEX}.
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001521 *
Esteban Talaverac1c83592016-02-17 17:56:15 +00001522 * <p>This method can be called on the {@link DevicePolicyManager} instance
1523 * returned by {@link #getParentProfileInstance(ComponentName)} in order to retrieve
1524 * restrictions on the parent profile.
1525 *
Robin Lee25e26452015-06-02 09:56:29 -07001526 * @param admin The name of the admin component to check, or {@code null} to
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001527 * aggregate all admins.
1528 * @return The minimum number of lower case letters required in the
1529 * password.
1530 */
Robin Lee25e26452015-06-02 09:56:29 -07001531 public int getPasswordMinimumLowerCase(@Nullable ComponentName admin) {
Makoto Onukicc4bbeb2015-09-17 10:28:24 -07001532 return getPasswordMinimumLowerCase(admin, myUserId());
Amith Yamasani599dd7c2012-09-14 23:20:08 -07001533 }
1534
1535 /** @hide per-user version */
Robin Lee25e26452015-06-02 09:56:29 -07001536 public int getPasswordMinimumLowerCase(@Nullable ComponentName admin, int userHandle) {
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001537 if (mService != null) {
1538 try {
Esteban Talavera62399912016-01-11 15:37:55 +00001539 return mService.getPasswordMinimumLowerCase(admin, userHandle, mParentInstance);
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001540 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07001541 throw e.rethrowFromSystemServer();
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001542 }
1543 }
1544 return 0;
1545 }
1546
1547 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07001548 * Called by an application that is administering the device to set the minimum number of
1549 * letters required in the password. After setting this, the user will not be able to enter a
1550 * new password that is not at least as restrictive as what has been set. Note that the current
1551 * password will remain until the user has set a new one, so the change does not take place
1552 * immediately. To prompt the user for a new password, use {@link #ACTION_SET_NEW_PASSWORD} or
1553 * {@link #ACTION_SET_NEW_PARENT_PROFILE_PASSWORD} after setting this value. This constraint is
1554 * only imposed if the administrator has also requested {@link #PASSWORD_QUALITY_COMPLEX} with
1555 * {@link #setPasswordQuality}. The default value is 1.
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001556 * <p>
1557 * The calling device admin must have requested
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07001558 * {@link DeviceAdminInfo#USES_POLICY_LIMIT_PASSWORD} to be able to call this method; if it has
1559 * not, a security exception will be thrown.
1560 * <p>
1561 * This method can be called on the {@link DevicePolicyManager} instance returned by
1562 * {@link #getParentProfileInstance(ComponentName)} in order to set restrictions on the parent
1563 * profile.
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001564 *
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07001565 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
1566 * @param length The new desired minimum number of letters required in the password. A value of
1567 * 0 means there is no restriction.
1568 * @throws SecurityException if {@code admin} is not an active administrator or {@code admin}
1569 * does not use {@link DeviceAdminInfo#USES_POLICY_LIMIT_PASSWORD}
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001570 */
Robin Lee25e26452015-06-02 09:56:29 -07001571 public void setPasswordMinimumLetters(@NonNull ComponentName admin, int length) {
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001572 if (mService != null) {
1573 try {
Esteban Talavera62399912016-01-11 15:37:55 +00001574 mService.setPasswordMinimumLetters(admin, length, mParentInstance);
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001575 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07001576 throw e.rethrowFromSystemServer();
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001577 }
1578 }
1579 }
1580
1581 /**
Esteban Talaverac1c83592016-02-17 17:56:15 +00001582 * Retrieve the current number of letters required in the password
1583 * for a particular admin or all admins that set retrictions on this user
1584 * and its participating profiles. Restrictions on profiles that have
1585 * a separate challenge are not taken into account.
1586 * This is the same value as set by
1587 * {@link #setPasswordMinimumLetters(ComponentName, int)}
Konstantin Lopyrevc8577402010-06-04 17:15:02 -07001588 * and only applies when the password quality is
1589 * {@link #PASSWORD_QUALITY_COMPLEX}.
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001590 *
Esteban Talaverac1c83592016-02-17 17:56:15 +00001591 * <p>This method can be called on the {@link DevicePolicyManager} instance
1592 * returned by {@link #getParentProfileInstance(ComponentName)} in order to retrieve
1593 * restrictions on the parent profile.
1594 *
Robin Lee25e26452015-06-02 09:56:29 -07001595 * @param admin The name of the admin component to check, or {@code null} to
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001596 * aggregate all admins.
1597 * @return The minimum number of letters required in the password.
1598 */
Robin Lee25e26452015-06-02 09:56:29 -07001599 public int getPasswordMinimumLetters(@Nullable ComponentName admin) {
Makoto Onukicc4bbeb2015-09-17 10:28:24 -07001600 return getPasswordMinimumLetters(admin, myUserId());
Amith Yamasani599dd7c2012-09-14 23:20:08 -07001601 }
1602
1603 /** @hide per-user version */
Robin Lee25e26452015-06-02 09:56:29 -07001604 public int getPasswordMinimumLetters(@Nullable ComponentName admin, int userHandle) {
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001605 if (mService != null) {
1606 try {
Esteban Talavera62399912016-01-11 15:37:55 +00001607 return mService.getPasswordMinimumLetters(admin, userHandle, mParentInstance);
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001608 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07001609 throw e.rethrowFromSystemServer();
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001610 }
1611 }
1612 return 0;
1613 }
1614
1615 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07001616 * Called by an application that is administering the device to set the minimum number of
1617 * numerical digits required in the password. After setting this, the user will not be able to
1618 * enter a new password that is not at least as restrictive as what has been set. Note that the
1619 * current password will remain until the user has set a new one, so the change does not take
1620 * place immediately. To prompt the user for a new password, use
1621 * {@link #ACTION_SET_NEW_PASSWORD} or {@link #ACTION_SET_NEW_PARENT_PROFILE_PASSWORD} after
1622 * setting this value. This constraint is only imposed if the administrator has also requested
1623 * {@link #PASSWORD_QUALITY_COMPLEX} with {@link #setPasswordQuality}. The default value is 1.
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001624 * <p>
1625 * The calling device admin must have requested
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07001626 * {@link DeviceAdminInfo#USES_POLICY_LIMIT_PASSWORD} to be able to call this method; if it has
1627 * not, a security exception will be thrown.
1628 * <p>
1629 * This method can be called on the {@link DevicePolicyManager} instance returned by
1630 * {@link #getParentProfileInstance(ComponentName)} in order to set restrictions on the parent
1631 * profile.
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001632 *
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07001633 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
1634 * @param length The new desired minimum number of numerical digits required in the password. A
1635 * value of 0 means there is no restriction.
1636 * @throws SecurityException if {@code admin} is not an active administrator or {@code admin}
1637 * does not use {@link DeviceAdminInfo#USES_POLICY_LIMIT_PASSWORD}
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001638 */
Robin Lee25e26452015-06-02 09:56:29 -07001639 public void setPasswordMinimumNumeric(@NonNull ComponentName admin, int length) {
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001640 if (mService != null) {
1641 try {
Esteban Talavera62399912016-01-11 15:37:55 +00001642 mService.setPasswordMinimumNumeric(admin, length, mParentInstance);
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001643 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07001644 throw e.rethrowFromSystemServer();
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001645 }
1646 }
1647 }
1648
1649 /**
1650 * Retrieve the current number of numerical digits required in the password
Esteban Talaverac1c83592016-02-17 17:56:15 +00001651 * for a particular admin or all admins that set retrictions on this user
1652 * and its participating profiles. Restrictions on profiles that have
1653 * a separate challenge are not taken into account.
Jessica Hummel91da58d2014-04-10 17:39:43 +01001654 * This is the same value as set by
Esteban Talaverac1c83592016-02-17 17:56:15 +00001655 * {@link #setPasswordMinimumNumeric(ComponentName, int)}
Konstantin Lopyrevc8577402010-06-04 17:15:02 -07001656 * and only applies when the password quality is
1657 * {@link #PASSWORD_QUALITY_COMPLEX}.
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001658 *
Esteban Talaverac1c83592016-02-17 17:56:15 +00001659 * <p>This method can be called on the {@link DevicePolicyManager} instance
1660 * returned by {@link #getParentProfileInstance(ComponentName)} in order to retrieve
1661 * restrictions on the parent profile.
1662 *
Robin Lee25e26452015-06-02 09:56:29 -07001663 * @param admin The name of the admin component to check, or {@code null} to
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001664 * aggregate all admins.
1665 * @return The minimum number of numerical digits required in the password.
1666 */
Robin Lee25e26452015-06-02 09:56:29 -07001667 public int getPasswordMinimumNumeric(@Nullable ComponentName admin) {
Makoto Onukicc4bbeb2015-09-17 10:28:24 -07001668 return getPasswordMinimumNumeric(admin, myUserId());
Amith Yamasani599dd7c2012-09-14 23:20:08 -07001669 }
1670
1671 /** @hide per-user version */
Robin Lee25e26452015-06-02 09:56:29 -07001672 public int getPasswordMinimumNumeric(@Nullable ComponentName admin, int userHandle) {
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001673 if (mService != null) {
1674 try {
Esteban Talavera62399912016-01-11 15:37:55 +00001675 return mService.getPasswordMinimumNumeric(admin, userHandle, mParentInstance);
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001676 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07001677 throw e.rethrowFromSystemServer();
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001678 }
1679 }
1680 return 0;
1681 }
1682
1683 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07001684 * Called by an application that is administering the device to set the minimum number of
1685 * symbols required in the password. After setting this, the user will not be able to enter a
1686 * new password that is not at least as restrictive as what has been set. Note that the current
1687 * password will remain until the user has set a new one, so the change does not take place
1688 * immediately. To prompt the user for a new password, use {@link #ACTION_SET_NEW_PASSWORD} or
1689 * {@link #ACTION_SET_NEW_PARENT_PROFILE_PASSWORD} after setting this value. This constraint is
1690 * only imposed if the administrator has also requested {@link #PASSWORD_QUALITY_COMPLEX} with
1691 * {@link #setPasswordQuality}. The default value is 1.
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001692 * <p>
1693 * The calling device admin must have requested
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07001694 * {@link DeviceAdminInfo#USES_POLICY_LIMIT_PASSWORD} to be able to call this method; if it has
1695 * not, a security exception will be thrown.
1696 * <p>
1697 * This method can be called on the {@link DevicePolicyManager} instance returned by
1698 * {@link #getParentProfileInstance(ComponentName)} in order to set restrictions on the parent
1699 * profile.
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001700 *
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07001701 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
1702 * @param length The new desired minimum number of symbols required in the password. A value of
1703 * 0 means there is no restriction.
1704 * @throws SecurityException if {@code admin} is not an active administrator or {@code admin}
1705 * does not use {@link DeviceAdminInfo#USES_POLICY_LIMIT_PASSWORD}
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001706 */
Robin Lee25e26452015-06-02 09:56:29 -07001707 public void setPasswordMinimumSymbols(@NonNull ComponentName admin, int length) {
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001708 if (mService != null) {
1709 try {
Esteban Talavera62399912016-01-11 15:37:55 +00001710 mService.setPasswordMinimumSymbols(admin, length, mParentInstance);
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001711 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07001712 throw e.rethrowFromSystemServer();
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001713 }
1714 }
1715 }
1716
1717 /**
Esteban Talaverac1c83592016-02-17 17:56:15 +00001718 * Retrieve the current number of symbols required in the password
1719 * for a particular admin or all admins that set retrictions on this user
1720 * and its participating profiles. Restrictions on profiles that have
1721 * a separate challenge are not taken into account. This is the same value as
1722 * set by {@link #setPasswordMinimumSymbols(ComponentName, int)}
Konstantin Lopyrevc8577402010-06-04 17:15:02 -07001723 * and only applies when the password quality is
1724 * {@link #PASSWORD_QUALITY_COMPLEX}.
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001725 *
Esteban Talaverac1c83592016-02-17 17:56:15 +00001726 * <p>This method can be called on the {@link DevicePolicyManager} instance
1727 * returned by {@link #getParentProfileInstance(ComponentName)} in order to retrieve
1728 * restrictions on the parent profile.
1729 *
Robin Lee25e26452015-06-02 09:56:29 -07001730 * @param admin The name of the admin component to check, or {@code null} to
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001731 * aggregate all admins.
1732 * @return The minimum number of symbols required in the password.
1733 */
Robin Lee25e26452015-06-02 09:56:29 -07001734 public int getPasswordMinimumSymbols(@Nullable ComponentName admin) {
Makoto Onukicc4bbeb2015-09-17 10:28:24 -07001735 return getPasswordMinimumSymbols(admin, myUserId());
Amith Yamasani599dd7c2012-09-14 23:20:08 -07001736 }
1737
1738 /** @hide per-user version */
Robin Lee25e26452015-06-02 09:56:29 -07001739 public int getPasswordMinimumSymbols(@Nullable ComponentName admin, int userHandle) {
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001740 if (mService != null) {
1741 try {
Esteban Talavera62399912016-01-11 15:37:55 +00001742 return mService.getPasswordMinimumSymbols(admin, userHandle, mParentInstance);
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001743 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07001744 throw e.rethrowFromSystemServer();
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001745 }
1746 }
1747 return 0;
1748 }
1749
Konstantin Lopyrevc8577402010-06-04 17:15:02 -07001750 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07001751 * Called by an application that is administering the device to set the minimum number of
1752 * non-letter characters (numerical digits or symbols) required in the password. After setting
1753 * this, the user will not be able to enter a new password that is not at least as restrictive
1754 * as what has been set. Note that the current password will remain until the user has set a new
1755 * one, so the change does not take place immediately. To prompt the user for a new password,
1756 * use {@link #ACTION_SET_NEW_PASSWORD} or {@link #ACTION_SET_NEW_PARENT_PROFILE_PASSWORD} after
1757 * setting this value. This constraint is only imposed if the administrator has also requested
1758 * {@link #PASSWORD_QUALITY_COMPLEX} with {@link #setPasswordQuality}. The default value is 0.
Konstantin Lopyrevc8577402010-06-04 17:15:02 -07001759 * <p>
1760 * The calling device admin must have requested
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07001761 * {@link DeviceAdminInfo#USES_POLICY_LIMIT_PASSWORD} to be able to call this method; if it has
1762 * not, a security exception will be thrown.
1763 * <p>
1764 * This method can be called on the {@link DevicePolicyManager} instance returned by
1765 * {@link #getParentProfileInstance(ComponentName)} in order to set restrictions on the parent
1766 * profile.
Konstantin Lopyrevc8577402010-06-04 17:15:02 -07001767 *
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07001768 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
1769 * @param length The new desired minimum number of letters required in the password. A value of
1770 * 0 means there is no restriction.
1771 * @throws SecurityException if {@code admin} is not an active administrator or {@code admin}
1772 * does not use {@link DeviceAdminInfo#USES_POLICY_LIMIT_PASSWORD}
Konstantin Lopyrevc8577402010-06-04 17:15:02 -07001773 */
Robin Lee25e26452015-06-02 09:56:29 -07001774 public void setPasswordMinimumNonLetter(@NonNull ComponentName admin, int length) {
Konstantin Lopyrevc8577402010-06-04 17:15:02 -07001775 if (mService != null) {
1776 try {
Esteban Talavera62399912016-01-11 15:37:55 +00001777 mService.setPasswordMinimumNonLetter(admin, length, mParentInstance);
Konstantin Lopyrevc8577402010-06-04 17:15:02 -07001778 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07001779 throw e.rethrowFromSystemServer();
Konstantin Lopyrevc8577402010-06-04 17:15:02 -07001780 }
1781 }
1782 }
1783
1784 /**
Esteban Talaverac1c83592016-02-17 17:56:15 +00001785 * Retrieve the current number of non-letter characters required in the password
1786 * for a particular admin or all admins that set retrictions on this user
1787 * and its participating profiles. Restrictions on profiles that have
1788 * a separate challenge are not taken into account.
Jessica Hummel91da58d2014-04-10 17:39:43 +01001789 * This is the same value as set by
Esteban Talaverac1c83592016-02-17 17:56:15 +00001790 * {@link #setPasswordMinimumNonLetter(ComponentName, int)}
Konstantin Lopyrevc8577402010-06-04 17:15:02 -07001791 * and only applies when the password quality is
1792 * {@link #PASSWORD_QUALITY_COMPLEX}.
1793 *
Esteban Talaverac1c83592016-02-17 17:56:15 +00001794 * <p>This method can be called on the {@link DevicePolicyManager} instance
1795 * returned by {@link #getParentProfileInstance(ComponentName)} in order to retrieve
1796 * restrictions on the parent profile.
1797 *
Robin Lee25e26452015-06-02 09:56:29 -07001798 * @param admin The name of the admin component to check, or {@code null} to
Konstantin Lopyrevc8577402010-06-04 17:15:02 -07001799 * aggregate all admins.
1800 * @return The minimum number of letters required in the password.
1801 */
Robin Lee25e26452015-06-02 09:56:29 -07001802 public int getPasswordMinimumNonLetter(@Nullable ComponentName admin) {
Makoto Onukicc4bbeb2015-09-17 10:28:24 -07001803 return getPasswordMinimumNonLetter(admin, myUserId());
Amith Yamasani599dd7c2012-09-14 23:20:08 -07001804 }
1805
1806 /** @hide per-user version */
Robin Lee25e26452015-06-02 09:56:29 -07001807 public int getPasswordMinimumNonLetter(@Nullable ComponentName admin, int userHandle) {
Konstantin Lopyrevc8577402010-06-04 17:15:02 -07001808 if (mService != null) {
1809 try {
Esteban Talavera62399912016-01-11 15:37:55 +00001810 return mService.getPasswordMinimumNonLetter(admin, userHandle, mParentInstance);
Konstantin Lopyrevc8577402010-06-04 17:15:02 -07001811 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07001812 throw e.rethrowFromSystemServer();
Konstantin Lopyrevc8577402010-06-04 17:15:02 -07001813 }
1814 }
1815 return 0;
1816 }
1817
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07001818 /**
1819 * Called by an application that is administering the device to set the length of the password
1820 * history. After setting this, the user will not be able to enter a new password that is the
1821 * same as any password in the history. Note that the current password will remain until the
1822 * user has set a new one, so the change does not take place immediately. To prompt the user for
1823 * a new password, use {@link #ACTION_SET_NEW_PASSWORD} or
1824 * {@link #ACTION_SET_NEW_PARENT_PROFILE_PASSWORD} after setting this value. This constraint is
1825 * only imposed if the administrator has also requested either {@link #PASSWORD_QUALITY_NUMERIC}
1826 * , {@link #PASSWORD_QUALITY_NUMERIC_COMPLEX} {@link #PASSWORD_QUALITY_ALPHABETIC}, or
1827 * {@link #PASSWORD_QUALITY_ALPHANUMERIC} with {@link #setPasswordQuality}.
1828 * <p>
1829 * The calling device admin must have requested
1830 * {@link DeviceAdminInfo#USES_POLICY_LIMIT_PASSWORD} to be able to call this method; if it has
1831 * not, a security exception will be thrown.
1832 * <p>
1833 * This method can be called on the {@link DevicePolicyManager} instance returned by
1834 * {@link #getParentProfileInstance(ComponentName)} in order to set restrictions on the parent
1835 * profile.
1836 *
1837 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
1838 * @param length The new desired length of password history. A value of 0 means there is no
1839 * restriction.
1840 * @throws SecurityException if {@code admin} is not an active administrator or {@code admin}
1841 * does not use {@link DeviceAdminInfo#USES_POLICY_LIMIT_PASSWORD}
1842 */
Robin Lee25e26452015-06-02 09:56:29 -07001843 public void setPasswordHistoryLength(@NonNull ComponentName admin, int length) {
Konstantin Lopyrev32558232010-05-20 16:18:05 -07001844 if (mService != null) {
1845 try {
Esteban Talavera62399912016-01-11 15:37:55 +00001846 mService.setPasswordHistoryLength(admin, length, mParentInstance);
Konstantin Lopyrev32558232010-05-20 16:18:05 -07001847 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07001848 throw e.rethrowFromSystemServer();
Konstantin Lopyrev32558232010-05-20 16:18:05 -07001849 }
1850 }
1851 }
1852
1853 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07001854 * Called by a device admin to set the password expiration timeout. Calling this method will
1855 * restart the countdown for password expiration for the given admin, as will changing the
1856 * device password (for all admins).
1857 * <p>
1858 * The provided timeout is the time delta in ms and will be added to the current time. For
1859 * example, to have the password expire 5 days from now, timeout would be 5 * 86400 * 1000 =
1860 * 432000000 ms for timeout.
1861 * <p>
1862 * To disable password expiration, a value of 0 may be used for timeout.
1863 * <p>
1864 * The calling device admin must have requested
1865 * {@link DeviceAdminInfo#USES_POLICY_EXPIRE_PASSWORD} to be able to call this method; if it has
1866 * not, a security exception will be thrown.
1867 * <p>
1868 * Note that setting the password will automatically reset the expiration time for all active
1869 * admins. Active admins do not need to explicitly call this method in that case.
1870 * <p>
1871 * This method can be called on the {@link DevicePolicyManager} instance returned by
1872 * {@link #getParentProfileInstance(ComponentName)} in order to set restrictions on the parent
1873 * profile.
Esteban Talaverac1c83592016-02-17 17:56:15 +00001874 *
Jim Millera4e28d12010-11-08 16:15:47 -08001875 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07001876 * @param timeout The limit (in ms) that a password can remain in effect. A value of 0 means
1877 * there is no restriction (unlimited).
1878 * @throws SecurityException if {@code admin} is not an active administrator or {@code admin}
1879 * does not use {@link DeviceAdminInfo#USES_POLICY_EXPIRE_PASSWORD}
Jim Millera4e28d12010-11-08 16:15:47 -08001880 */
Robin Lee25e26452015-06-02 09:56:29 -07001881 public void setPasswordExpirationTimeout(@NonNull ComponentName admin, long timeout) {
Jim Millera4e28d12010-11-08 16:15:47 -08001882 if (mService != null) {
1883 try {
Esteban Talavera62399912016-01-11 15:37:55 +00001884 mService.setPasswordExpirationTimeout(admin, timeout, mParentInstance);
Jim Millera4e28d12010-11-08 16:15:47 -08001885 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07001886 throw e.rethrowFromSystemServer();
Jim Millera4e28d12010-11-08 16:15:47 -08001887 }
1888 }
1889 }
1890
1891 /**
Jim Miller6b857682011-02-16 16:27:41 -08001892 * Get the password expiration timeout for the given admin. The expiration timeout is the
1893 * recurring expiration timeout provided in the call to
1894 * {@link #setPasswordExpirationTimeout(ComponentName, long)} for the given admin or the
Esteban Talaverac1c83592016-02-17 17:56:15 +00001895 * aggregate of all participating policy administrators if {@code admin} is null. Admins that
1896 * have set restrictions on profiles that have a separate challenge are not taken into account.
1897 *
1898 * <p>This method can be called on the {@link DevicePolicyManager} instance
1899 * returned by {@link #getParentProfileInstance(ComponentName)} in order to retrieve
1900 * restrictions on the parent profile.
Jim Millera4e28d12010-11-08 16:15:47 -08001901 *
Robin Lee25e26452015-06-02 09:56:29 -07001902 * @param admin The name of the admin component to check, or {@code null} to aggregate all admins.
Jim Millera4e28d12010-11-08 16:15:47 -08001903 * @return The timeout for the given admin or the minimum of all timeouts
1904 */
Robin Lee25e26452015-06-02 09:56:29 -07001905 public long getPasswordExpirationTimeout(@Nullable ComponentName admin) {
Jim Millera4e28d12010-11-08 16:15:47 -08001906 if (mService != null) {
1907 try {
Esteban Talavera62399912016-01-11 15:37:55 +00001908 return mService.getPasswordExpirationTimeout(admin, myUserId(), mParentInstance);
Jim Millera4e28d12010-11-08 16:15:47 -08001909 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07001910 throw e.rethrowFromSystemServer();
Jim Millera4e28d12010-11-08 16:15:47 -08001911 }
1912 }
1913 return 0;
1914 }
1915
1916 /**
Esteban Talaverac1c83592016-02-17 17:56:15 +00001917 * Get the current password expiration time for a particular admin or all admins that set
1918 * retrictions on this user and its participating profiles. Restrictions on profiles that have
1919 * a separate challenge are not taken into account. If admin is {@code null}, then a composite
1920 * of all expiration times is returned - which will be the minimum of all of them.
1921 *
1922 * <p>This method can be called on the {@link DevicePolicyManager} instance
1923 * returned by {@link #getParentProfileInstance(ComponentName)} in order to retrieve
1924 * the password expiration for the parent profile.
Jim Millera4e28d12010-11-08 16:15:47 -08001925 *
Robin Lee25e26452015-06-02 09:56:29 -07001926 * @param admin The name of the admin component to check, or {@code null} to aggregate all admins.
Esteban Talaverac1c83592016-02-17 17:56:15 +00001927 * @return The password expiration time, in milliseconds since epoch.
Jim Millera4e28d12010-11-08 16:15:47 -08001928 */
Robin Lee25e26452015-06-02 09:56:29 -07001929 public long getPasswordExpiration(@Nullable ComponentName admin) {
Jim Millera4e28d12010-11-08 16:15:47 -08001930 if (mService != null) {
1931 try {
Esteban Talavera62399912016-01-11 15:37:55 +00001932 return mService.getPasswordExpiration(admin, myUserId(), mParentInstance);
Jim Millera4e28d12010-11-08 16:15:47 -08001933 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07001934 throw e.rethrowFromSystemServer();
Jim Millera4e28d12010-11-08 16:15:47 -08001935 }
1936 }
1937 return 0;
1938 }
1939
1940 /**
Esteban Talaverac1c83592016-02-17 17:56:15 +00001941 * Retrieve the current password history length for a particular admin or all admins that
1942 * set retrictions on this user and its participating profiles. Restrictions on profiles that
1943 * have a separate challenge are not taken into account.
1944 *
1945 * <p>This method can be called on the {@link DevicePolicyManager} instance
1946 * returned by {@link #getParentProfileInstance(ComponentName)} in order to retrieve
1947 * restrictions on the parent profile.
1948 *
Robin Lee25e26452015-06-02 09:56:29 -07001949 * @param admin The name of the admin component to check, or {@code null} to aggregate
Konstantin Lopyrev32558232010-05-20 16:18:05 -07001950 * all admins.
1951 * @return The length of the password history
1952 */
Robin Lee25e26452015-06-02 09:56:29 -07001953 public int getPasswordHistoryLength(@Nullable ComponentName admin) {
Makoto Onukicc4bbeb2015-09-17 10:28:24 -07001954 return getPasswordHistoryLength(admin, myUserId());
Amith Yamasani599dd7c2012-09-14 23:20:08 -07001955 }
1956
1957 /** @hide per-user version */
Robin Lee25e26452015-06-02 09:56:29 -07001958 public int getPasswordHistoryLength(@Nullable ComponentName admin, int userHandle) {
Konstantin Lopyrev32558232010-05-20 16:18:05 -07001959 if (mService != null) {
1960 try {
Esteban Talavera62399912016-01-11 15:37:55 +00001961 return mService.getPasswordHistoryLength(admin, userHandle, mParentInstance);
Konstantin Lopyrev32558232010-05-20 16:18:05 -07001962 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07001963 throw e.rethrowFromSystemServer();
Konstantin Lopyrev32558232010-05-20 16:18:05 -07001964 }
1965 }
1966 return 0;
1967 }
1968
Dianne Hackbornd6847842010-01-12 18:14:19 -08001969 /**
Dianne Hackborn254cb442010-01-27 19:23:59 -08001970 * Return the maximum password length that the device supports for a
Dianne Hackborn9327f4f2010-01-29 10:38:29 -08001971 * particular password quality.
Dianne Hackborn364f6e32010-01-29 17:38:20 -08001972 * @param quality The quality being interrogated.
Dianne Hackborn254cb442010-01-27 19:23:59 -08001973 * @return Returns the maximum length that the user can enter.
1974 */
Dianne Hackborn9327f4f2010-01-29 10:38:29 -08001975 public int getPasswordMaximumLength(int quality) {
Dianne Hackborn254cb442010-01-27 19:23:59 -08001976 // Kind-of arbitrary.
1977 return 16;
1978 }
Konstantin Lopyrev32558232010-05-20 16:18:05 -07001979
Dianne Hackborn254cb442010-01-27 19:23:59 -08001980 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07001981 * Determine whether the current password the user has set is sufficient to meet the policy
1982 * requirements (e.g. quality, minimum length) that have been requested by the admins of this
1983 * user and its participating profiles. Restrictions on profiles that have a separate challenge
1984 * are not taken into account.
1985 * <p>
1986 * The calling device admin must have requested
1987 * {@link DeviceAdminInfo#USES_POLICY_LIMIT_PASSWORD} to be able to call this method; if it has
1988 * not, a security exception will be thrown.
1989 * <p>
1990 * This method can be called on the {@link DevicePolicyManager} instance returned by
1991 * {@link #getParentProfileInstance(ComponentName)} in order to determine if the password set on
1992 * the parent profile is sufficient.
Esteban Talaverac1c83592016-02-17 17:56:15 +00001993 *
Jessica Hummel91da58d2014-04-10 17:39:43 +01001994 * @return Returns true if the password meets the current requirements, else false.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07001995 * @throws SecurityException if the calling application does not own an active administrator
1996 * that uses {@link DeviceAdminInfo#USES_POLICY_LIMIT_PASSWORD}
Dianne Hackbornd6847842010-01-12 18:14:19 -08001997 */
Dianne Hackborndf83afa2010-01-20 13:37:26 -08001998 public boolean isActivePasswordSufficient() {
Dianne Hackbornd6847842010-01-12 18:14:19 -08001999 if (mService != null) {
2000 try {
Clara Bayarri3e826ef2015-12-14 17:51:22 +00002001 return mService.isActivePasswordSufficient(myUserId(), mParentInstance);
Dianne Hackbornd6847842010-01-12 18:14:19 -08002002 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07002003 throw e.rethrowFromSystemServer();
Dianne Hackbornd6847842010-01-12 18:14:19 -08002004 }
2005 }
Dianne Hackborndf83afa2010-01-20 13:37:26 -08002006 return false;
Dianne Hackbornd6847842010-01-12 18:14:19 -08002007 }
Konstantin Lopyrev32558232010-05-20 16:18:05 -07002008
Dianne Hackbornd6847842010-01-12 18:14:19 -08002009 /**
Clara Bayarrid7693912016-01-22 17:26:31 +00002010 * Determine whether the current profile password the user has set is sufficient
Esteban Talaverac1c83592016-02-17 17:56:15 +00002011 * to meet the policy requirements (e.g. quality, minimum length) that have been
Clara Bayarrid7693912016-01-22 17:26:31 +00002012 * requested by the admins of the parent user and its profiles.
2013 *
2014 * @param userHandle the userId of the profile to check the password for.
2015 * @return Returns true if the password would meet the current requirements, else false.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07002016 * @throws SecurityException if {@code userHandle} is not a managed profile.
Clara Bayarrid7693912016-01-22 17:26:31 +00002017 * @hide
2018 */
2019 public boolean isProfileActivePasswordSufficientForParent(int userHandle) {
2020 if (mService != null) {
2021 try {
2022 return mService.isProfileActivePasswordSufficientForParent(userHandle);
2023 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07002024 throw e.rethrowFromSystemServer();
Clara Bayarrid7693912016-01-22 17:26:31 +00002025 }
2026 }
2027 return false;
2028 }
2029
2030 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07002031 * Retrieve the number of times the user has failed at entering a password since that last
2032 * successful password entry.
2033 * <p>
2034 * This method can be called on the {@link DevicePolicyManager} instance returned by
2035 * {@link #getParentProfileInstance(ComponentName)} in order to retrieve the number of failed
2036 * password attemts for the parent user.
2037 * <p>
2038 * The calling device admin must have requested {@link DeviceAdminInfo#USES_POLICY_WATCH_LOGIN}
2039 * to be able to call this method; if it has not, a security exception will be thrown.
Konstantin Lopyrev32558232010-05-20 16:18:05 -07002040 *
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07002041 * @return The number of times user has entered an incorrect password since the last correct
2042 * password entry.
2043 * @throws SecurityException if the calling application does not own an active administrator
2044 * that uses {@link DeviceAdminInfo#USES_POLICY_WATCH_LOGIN}
Dianne Hackbornd6847842010-01-12 18:14:19 -08002045 */
2046 public int getCurrentFailedPasswordAttempts() {
Clara Bayarri51e41ad2016-02-11 17:48:53 +00002047 return getCurrentFailedPasswordAttempts(myUserId());
2048 }
2049
2050 /**
2051 * Retrieve the number of times the given user has failed at entering a
2052 * password since that last successful password entry.
2053 *
2054 * <p>The calling device admin must have requested
2055 * {@link DeviceAdminInfo#USES_POLICY_WATCH_LOGIN} to be able to call this method; if it has
2056 * not and it is not the system uid, a security exception will be thrown.
2057 *
2058 * @hide
2059 */
2060 public int getCurrentFailedPasswordAttempts(int userHandle) {
Dianne Hackbornd6847842010-01-12 18:14:19 -08002061 if (mService != null) {
2062 try {
Clara Bayarri51e41ad2016-02-11 17:48:53 +00002063 return mService.getCurrentFailedPasswordAttempts(userHandle, mParentInstance);
Dianne Hackbornd6847842010-01-12 18:14:19 -08002064 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07002065 throw e.rethrowFromSystemServer();
Dianne Hackbornd6847842010-01-12 18:14:19 -08002066 }
2067 }
2068 return -1;
2069 }
Dianne Hackborndf83afa2010-01-20 13:37:26 -08002070
2071 /**
Craig Lafayette4e401fa2015-05-07 10:24:02 -04002072 * Queries whether {@link #RESET_PASSWORD_DO_NOT_ASK_CREDENTIALS_ON_BOOT} flag is set.
Andrei Kapishnikov4eb6a362015-04-02 15:21:20 -04002073 *
Craig Lafayette4e401fa2015-05-07 10:24:02 -04002074 * @return true if RESET_PASSWORD_DO_NOT_ASK_CREDENTIALS_ON_BOOT flag is set.
Andrei Kapishnikov4eb6a362015-04-02 15:21:20 -04002075 * @hide
2076 */
2077 public boolean getDoNotAskCredentialsOnBoot() {
2078 if (mService != null) {
2079 try {
2080 return mService.getDoNotAskCredentialsOnBoot();
2081 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07002082 throw e.rethrowFromSystemServer();
Andrei Kapishnikov4eb6a362015-04-02 15:21:20 -04002083 }
2084 }
2085 return false;
2086 }
2087
2088 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07002089 * Setting this to a value greater than zero enables a built-in policy that will perform a
2090 * device or profile wipe after too many incorrect device-unlock passwords have been entered.
2091 * This built-in policy combines watching for failed passwords and wiping the device, and
2092 * requires that you request both {@link DeviceAdminInfo#USES_POLICY_WATCH_LOGIN} and
Dianne Hackborn8ea138c2010-01-26 18:01:04 -08002093 * {@link DeviceAdminInfo#USES_POLICY_WIPE_DATA}}.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07002094 * <p>
2095 * To implement any other policy (e.g. wiping data for a particular application only, erasing or
2096 * revoking credentials, or reporting the failure to a server), you should implement
2097 * {@link DeviceAdminReceiver#onPasswordFailed(Context, android.content.Intent)} instead. Do not
2098 * use this API, because if the maximum count is reached, the device or profile will be wiped
2099 * immediately, and your callback will not be invoked.
2100 * <p>
2101 * This method can be called on the {@link DevicePolicyManager} instance returned by
2102 * {@link #getParentProfileInstance(ComponentName)} in order to set a value on the parent
2103 * profile.
Konstantin Lopyrev32558232010-05-20 16:18:05 -07002104 *
Dianne Hackbornef6b22f2010-02-16 20:38:49 -08002105 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07002106 * @param num The number of failed password attempts at which point the device or profile will
2107 * be wiped.
2108 * @throws SecurityException if {@code admin} is not an active administrator or does not use
2109 * both {@link DeviceAdminInfo#USES_POLICY_WATCH_LOGIN} and
2110 * {@link DeviceAdminInfo#USES_POLICY_WIPE_DATA}.
Dianne Hackborn8ea138c2010-01-26 18:01:04 -08002111 */
Robin Lee25e26452015-06-02 09:56:29 -07002112 public void setMaximumFailedPasswordsForWipe(@NonNull ComponentName admin, int num) {
Dianne Hackborn8ea138c2010-01-26 18:01:04 -08002113 if (mService != null) {
2114 try {
Esteban Talavera62399912016-01-11 15:37:55 +00002115 mService.setMaximumFailedPasswordsForWipe(admin, num, mParentInstance);
Dianne Hackborn8ea138c2010-01-26 18:01:04 -08002116 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07002117 throw e.rethrowFromSystemServer();
Dianne Hackborn8ea138c2010-01-26 18:01:04 -08002118 }
2119 }
2120 }
Konstantin Lopyrev32558232010-05-20 16:18:05 -07002121
Dianne Hackborn8ea138c2010-01-26 18:01:04 -08002122 /**
Esteban Talaverac1c83592016-02-17 17:56:15 +00002123 * Retrieve the current maximum number of login attempts that are allowed before the device
2124 * or profile is wiped, for a particular admin or all admins that set retrictions on this user
2125 * and its participating profiles. Restrictions on profiles that have a separate challenge are
2126 * not taken into account.
2127 *
2128 * <p>This method can be called on the {@link DevicePolicyManager} instance
2129 * returned by {@link #getParentProfileInstance(ComponentName)} in order to retrieve
2130 * the value for the parent profile.
2131 *
Robin Lee25e26452015-06-02 09:56:29 -07002132 * @param admin The name of the admin component to check, or {@code null} to aggregate
Dianne Hackborn254cb442010-01-27 19:23:59 -08002133 * all admins.
2134 */
Robin Lee25e26452015-06-02 09:56:29 -07002135 public int getMaximumFailedPasswordsForWipe(@Nullable ComponentName admin) {
Makoto Onukicc4bbeb2015-09-17 10:28:24 -07002136 return getMaximumFailedPasswordsForWipe(admin, myUserId());
Amith Yamasani599dd7c2012-09-14 23:20:08 -07002137 }
2138
2139 /** @hide per-user version */
Robin Lee25e26452015-06-02 09:56:29 -07002140 public int getMaximumFailedPasswordsForWipe(@Nullable ComponentName admin, int userHandle) {
Dianne Hackborn254cb442010-01-27 19:23:59 -08002141 if (mService != null) {
2142 try {
Esteban Talavera62399912016-01-11 15:37:55 +00002143 return mService.getMaximumFailedPasswordsForWipe(
2144 admin, userHandle, mParentInstance);
Dianne Hackborn254cb442010-01-27 19:23:59 -08002145 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07002146 throw e.rethrowFromSystemServer();
Dianne Hackborn254cb442010-01-27 19:23:59 -08002147 }
2148 }
2149 return 0;
2150 }
Konstantin Lopyrev32558232010-05-20 16:18:05 -07002151
Dianne Hackborn254cb442010-01-27 19:23:59 -08002152 /**
Amith Yamasani3a3d2122014-10-29 11:41:31 -07002153 * Returns the profile with the smallest maximum failed passwords for wipe,
2154 * for the given user. So for primary user, it might return the primary or
2155 * a managed profile. For a secondary user, it would be the same as the
2156 * user passed in.
2157 * @hide Used only by Keyguard
2158 */
2159 public int getProfileWithMinimumFailedPasswordsForWipe(int userHandle) {
2160 if (mService != null) {
2161 try {
Esteban Talavera62399912016-01-11 15:37:55 +00002162 return mService.getProfileWithMinimumFailedPasswordsForWipe(
2163 userHandle, mParentInstance);
Amith Yamasani3a3d2122014-10-29 11:41:31 -07002164 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07002165 throw e.rethrowFromSystemServer();
Amith Yamasani3a3d2122014-10-29 11:41:31 -07002166 }
2167 }
2168 return UserHandle.USER_NULL;
2169 }
2170
2171 /**
Dianne Hackborn87bba1e2010-02-26 17:25:54 -08002172 * Flag for {@link #resetPassword}: don't allow other admins to change
2173 * the password again until the user has entered it.
2174 */
2175 public static final int RESET_PASSWORD_REQUIRE_ENTRY = 0x0001;
Konstantin Lopyrev32558232010-05-20 16:18:05 -07002176
Dianne Hackborn87bba1e2010-02-26 17:25:54 -08002177 /**
Andrei Kapishnikov4eb6a362015-04-02 15:21:20 -04002178 * Flag for {@link #resetPassword}: don't ask for user credentials on device boot.
2179 * If the flag is set, the device can be booted without asking for user password.
2180 * The absence of this flag does not change the current boot requirements. This flag
2181 * can be set by the device owner only. If the app is not the device owner, the flag
2182 * is ignored. Once the flag is set, it cannot be reverted back without resetting the
2183 * device to factory defaults.
2184 */
Craig Lafayette4e401fa2015-05-07 10:24:02 -04002185 public static final int RESET_PASSWORD_DO_NOT_ASK_CREDENTIALS_ON_BOOT = 0x0002;
Andrei Kapishnikov4eb6a362015-04-02 15:21:20 -04002186
2187 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07002188 * Force a new device unlock password (the password needed to access the entire device, not for
2189 * individual accounts) on the user. This takes effect immediately.
2190 * <p>
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07002191 * <em>Note: This API has been limited as of {@link android.os.Build.VERSION_CODES#N} for
Makoto Onuki70f929e2015-11-11 12:40:15 -08002192 * device admins that are not device owner and not profile owner.
2193 * The password can now only be changed if there is currently no password set. Device owner
2194 * and profile owner can still do this.</em>
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07002195 * <p>
2196 * The given password must be sufficient for the current password quality and length constraints
2197 * as returned by {@link #getPasswordQuality(ComponentName)} and
2198 * {@link #getPasswordMinimumLength(ComponentName)}; if it does not meet these constraints, then
2199 * it will be rejected and false returned. Note that the password may be a stronger quality
2200 * (containing alphanumeric characters when the requested quality is only numeric), in which
2201 * case the currently active quality will be increased to match.
2202 * <p>
2203 * Calling with a null or empty password will clear any existing PIN, pattern or password if the
Robin Leece5c4002016-03-23 17:05:03 +00002204 * current password constraints allow it. <em>Note: This will not work in
2205 * {@link android.os.Build.VERSION_CODES#N} and later for managed profiles, or for device admins
2206 * that are not device owner or profile owner. Once set, the password cannot be changed to null
2207 * or empty except by these admins.</em>
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07002208 * <p>
2209 * The calling device admin must have requested
2210 * {@link DeviceAdminInfo#USES_POLICY_RESET_PASSWORD} to be able to call this method; if it has
2211 * not, a security exception will be thrown.
Konstantin Lopyrev32558232010-05-20 16:18:05 -07002212 *
Adrian Roosf8f56bc2014-11-20 23:55:34 +01002213 * @param password The new password for the user. Null or empty clears the password.
Andrei Kapishnikov4eb6a362015-04-02 15:21:20 -04002214 * @param flags May be 0 or combination of {@link #RESET_PASSWORD_REQUIRE_ENTRY} and
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07002215 * {@link #RESET_PASSWORD_DO_NOT_ASK_CREDENTIALS_ON_BOOT}.
2216 * @return Returns true if the password was applied, or false if it is not acceptable for the
2217 * current constraints or if the user has not been decrypted yet.
2218 * @throws SecurityException if the calling application does not own an active administrator
2219 * that uses {@link DeviceAdminInfo#USES_POLICY_RESET_PASSWORD}
Dianne Hackborndf83afa2010-01-20 13:37:26 -08002220 */
Dianne Hackborn87bba1e2010-02-26 17:25:54 -08002221 public boolean resetPassword(String password, int flags) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01002222 throwIfParentInstance("resetPassword");
Dianne Hackborndf83afa2010-01-20 13:37:26 -08002223 if (mService != null) {
2224 try {
Fyodor Kupolovbdc58c62015-01-29 13:24:03 -08002225 return mService.resetPassword(password, flags);
Dianne Hackborndf83afa2010-01-20 13:37:26 -08002226 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07002227 throw e.rethrowFromSystemServer();
Dianne Hackborndf83afa2010-01-20 13:37:26 -08002228 }
2229 }
2230 return false;
2231 }
Konstantin Lopyrev32558232010-05-20 16:18:05 -07002232
Dianne Hackbornd6847842010-01-12 18:14:19 -08002233 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07002234 * Called by an application that is administering the device to set the maximum time for user
2235 * activity until the device will lock. This limits the length that the user can set. It takes
2236 * effect immediately.
2237 * <p>
2238 * The calling device admin must have requested {@link DeviceAdminInfo#USES_POLICY_FORCE_LOCK}
2239 * to be able to call this method; if it has not, a security exception will be thrown.
2240 * <p>
2241 * This method can be called on the {@link DevicePolicyManager} instance returned by
2242 * {@link #getParentProfileInstance(ComponentName)} in order to set restrictions on the parent
2243 * profile.
Esteban Talaverac1c83592016-02-17 17:56:15 +00002244 *
Dianne Hackbornef6b22f2010-02-16 20:38:49 -08002245 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07002246 * @param timeMs The new desired maximum time to lock in milliseconds. A value of 0 means there
2247 * is no restriction.
2248 * @throws SecurityException if {@code admin} is not an active administrator or it does not use
2249 * {@link DeviceAdminInfo#USES_POLICY_FORCE_LOCK}
Dianne Hackbornd6847842010-01-12 18:14:19 -08002250 */
Robin Lee25e26452015-06-02 09:56:29 -07002251 public void setMaximumTimeToLock(@NonNull ComponentName admin, long timeMs) {
Dianne Hackbornd6847842010-01-12 18:14:19 -08002252 if (mService != null) {
2253 try {
Esteban Talavera62399912016-01-11 15:37:55 +00002254 mService.setMaximumTimeToLock(admin, timeMs, mParentInstance);
Dianne Hackbornd6847842010-01-12 18:14:19 -08002255 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07002256 throw e.rethrowFromSystemServer();
Dianne Hackbornd6847842010-01-12 18:14:19 -08002257 }
2258 }
2259 }
Konstantin Lopyrev32558232010-05-20 16:18:05 -07002260
Dianne Hackbornd6847842010-01-12 18:14:19 -08002261 /**
Esteban Talaverac1c83592016-02-17 17:56:15 +00002262 * Retrieve the current maximum time to unlock for a particular admin or all admins that set
2263 * retrictions on this user and its participating profiles. Restrictions on profiles that have
2264 * a separate challenge are not taken into account.
2265 *
2266 * <p>This method can be called on the {@link DevicePolicyManager} instance
2267 * returned by {@link #getParentProfileInstance(ComponentName)} in order to retrieve
2268 * restrictions on the parent profile.
2269 *
Robin Lee25e26452015-06-02 09:56:29 -07002270 * @param admin The name of the admin component to check, or {@code null} to aggregate
Dianne Hackborn254cb442010-01-27 19:23:59 -08002271 * all admins.
Jim Millerd4efaac2014-08-14 18:02:45 -07002272 * @return time in milliseconds for the given admin or the minimum value (strictest) of
Jim Miller76b9b8b2014-08-22 17:04:57 -07002273 * all admins if admin is null. Returns 0 if there are no restrictions.
Dianne Hackbornd6847842010-01-12 18:14:19 -08002274 */
Robin Lee25e26452015-06-02 09:56:29 -07002275 public long getMaximumTimeToLock(@Nullable ComponentName admin) {
Makoto Onukicc4bbeb2015-09-17 10:28:24 -07002276 return getMaximumTimeToLock(admin, myUserId());
Amith Yamasani599dd7c2012-09-14 23:20:08 -07002277 }
2278
2279 /** @hide per-user version */
Robin Lee25e26452015-06-02 09:56:29 -07002280 public long getMaximumTimeToLock(@Nullable ComponentName admin, int userHandle) {
Dianne Hackbornd6847842010-01-12 18:14:19 -08002281 if (mService != null) {
2282 try {
Esteban Talavera62399912016-01-11 15:37:55 +00002283 return mService.getMaximumTimeToLock(admin, userHandle, mParentInstance);
Dianne Hackbornd6847842010-01-12 18:14:19 -08002284 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07002285 throw e.rethrowFromSystemServer();
Dianne Hackbornd6847842010-01-12 18:14:19 -08002286 }
2287 }
2288 return 0;
2289 }
Konstantin Lopyrev32558232010-05-20 16:18:05 -07002290
Dianne Hackbornd6847842010-01-12 18:14:19 -08002291 /**
Ricky Wai035e9242016-03-18 16:43:31 +00002292 * Returns maximum time to lock that applied by all profiles in this user. We do this because we
2293 * do not have a separate timeout to lock for work challenge only.
2294 *
2295 * @hide
2296 */
2297 public long getMaximumTimeToLockForUserAndProfiles(int userHandle) {
2298 if (mService != null) {
2299 try {
2300 return mService.getMaximumTimeToLockForUserAndProfiles(userHandle);
2301 } catch (RemoteException e) {
2302 throw e.rethrowFromSystemServer();
2303 }
2304 }
2305 return 0;
2306 }
2307
2308 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07002309 * Make the device lock immediately, as if the lock screen timeout has expired at the point of
2310 * this call.
2311 * <p>
2312 * The calling device admin must have requested {@link DeviceAdminInfo#USES_POLICY_FORCE_LOCK}
2313 * to be able to call this method; if it has not, a security exception will be thrown.
2314 * <p>
2315 * This method can be called on the {@link DevicePolicyManager} instance returned by
2316 * {@link #getParentProfileInstance(ComponentName)} in order to lock the parent profile.
Konstantin Lopyrev32558232010-05-20 16:18:05 -07002317 *
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07002318 * @throws SecurityException if the calling application does not own an active administrator
2319 * that uses {@link DeviceAdminInfo#USES_POLICY_FORCE_LOCK}
Dianne Hackbornd6847842010-01-12 18:14:19 -08002320 */
Dianne Hackborndf83afa2010-01-20 13:37:26 -08002321 public void lockNow() {
2322 if (mService != null) {
2323 try {
Esteban Talavera62399912016-01-11 15:37:55 +00002324 mService.lockNow(mParentInstance);
Dianne Hackborndf83afa2010-01-20 13:37:26 -08002325 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07002326 throw e.rethrowFromSystemServer();
Dianne Hackborndf83afa2010-01-20 13:37:26 -08002327 }
2328 }
2329 }
Konstantin Lopyrev32558232010-05-20 16:18:05 -07002330
Dianne Hackbornd6847842010-01-12 18:14:19 -08002331 /**
Dianne Hackborn42499172010-10-15 18:45:07 -07002332 * Flag for {@link #wipeData(int)}: also erase the device's external
Paul Crowleya7e87ac2014-11-18 13:50:19 +00002333 * storage (such as SD cards).
Dianne Hackborn42499172010-10-15 18:45:07 -07002334 */
2335 public static final int WIPE_EXTERNAL_STORAGE = 0x0001;
2336
2337 /**
Paul Crowleya7e87ac2014-11-18 13:50:19 +00002338 * Flag for {@link #wipeData(int)}: also erase the factory reset protection
2339 * data.
2340 *
Paul Crowley2934b262014-12-02 11:21:13 +00002341 * <p>This flag may only be set by device owner admins; if it is set by
2342 * other admins a {@link SecurityException} will be thrown.
Paul Crowleya7e87ac2014-11-18 13:50:19 +00002343 */
2344 public static final int WIPE_RESET_PROTECTION_DATA = 0x0002;
2345
2346 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07002347 * Ask the user data be wiped. Wiping the primary user will cause the device to reboot, erasing
2348 * all user data while next booting up.
2349 * <p>
2350 * The calling device admin must have requested {@link DeviceAdminInfo#USES_POLICY_WIPE_DATA} to
2351 * be able to call this method; if it has not, a security exception will be thrown.
Konstantin Lopyrev32558232010-05-20 16:18:05 -07002352 *
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07002353 * @param flags Bit mask of additional options: currently supported flags are
2354 * {@link #WIPE_EXTERNAL_STORAGE} and {@link #WIPE_RESET_PROTECTION_DATA}.
2355 * @throws SecurityException if the calling application does not own an active administrator
2356 * that uses {@link DeviceAdminInfo#USES_POLICY_WIPE_DATA}
Dianne Hackbornd6847842010-01-12 18:14:19 -08002357 */
2358 public void wipeData(int flags) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01002359 throwIfParentInstance("wipeData");
Dianne Hackbornd6847842010-01-12 18:14:19 -08002360 if (mService != null) {
2361 try {
Makoto Onuki70f929e2015-11-11 12:40:15 -08002362 mService.wipeData(flags);
Dianne Hackbornd6847842010-01-12 18:14:19 -08002363 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07002364 throw e.rethrowFromSystemServer();
Dianne Hackbornd6847842010-01-12 18:14:19 -08002365 }
2366 }
2367 }
Konstantin Lopyrev32558232010-05-20 16:18:05 -07002368
Dianne Hackbornd6847842010-01-12 18:14:19 -08002369 /**
Oscar Montemayor69238c62010-08-03 10:51:06 -07002370 * Called by an application that is administering the device to set the
2371 * global proxy and exclusion list.
2372 * <p>
2373 * The calling device admin must have requested
2374 * {@link DeviceAdminInfo#USES_POLICY_SETS_GLOBAL_PROXY} to be able to call
2375 * this method; if it has not, a security exception will be thrown.
2376 * Only the first device admin can set the proxy. If a second admin attempts
2377 * to set the proxy, the {@link ComponentName} of the admin originally setting the
Robin Lee25e26452015-06-02 09:56:29 -07002378 * proxy will be returned. If successful in setting the proxy, {@code null} will
Oscar Montemayor69238c62010-08-03 10:51:06 -07002379 * be returned.
2380 * The method can be called repeatedly by the device admin alrady setting the
2381 * proxy to update the proxy and exclusion list.
2382 *
Robin Lee25e26452015-06-02 09:56:29 -07002383 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
Oscar Montemayor69238c62010-08-03 10:51:06 -07002384 * @param proxySpec the global proxy desired. Must be an HTTP Proxy.
2385 * Pass Proxy.NO_PROXY to reset the proxy.
2386 * @param exclusionList a list of domains to be excluded from the global proxy.
Robin Lee25e26452015-06-02 09:56:29 -07002387 * @return {@code null} if the proxy was successfully set, or otherwise a {@link ComponentName}
2388 * of the device admin that sets the proxy.
Andy Stadlerd2672722011-02-16 10:53:33 -08002389 * @hide
Oscar Montemayor69238c62010-08-03 10:51:06 -07002390 */
Robin Lee25e26452015-06-02 09:56:29 -07002391 public ComponentName setGlobalProxy(@NonNull ComponentName admin, Proxy proxySpec,
Oscar Montemayor69238c62010-08-03 10:51:06 -07002392 List<String> exclusionList ) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01002393 throwIfParentInstance("setGlobalProxy");
Oscar Montemayor69238c62010-08-03 10:51:06 -07002394 if (proxySpec == null) {
2395 throw new NullPointerException();
2396 }
2397 if (mService != null) {
2398 try {
2399 String hostSpec;
2400 String exclSpec;
2401 if (proxySpec.equals(Proxy.NO_PROXY)) {
2402 hostSpec = null;
2403 exclSpec = null;
2404 } else {
2405 if (!proxySpec.type().equals(Proxy.Type.HTTP)) {
2406 throw new IllegalArgumentException();
2407 }
2408 InetSocketAddress sa = (InetSocketAddress)proxySpec.address();
2409 String hostName = sa.getHostName();
2410 int port = sa.getPort();
2411 StringBuilder hostBuilder = new StringBuilder();
2412 hostSpec = hostBuilder.append(hostName)
2413 .append(":").append(Integer.toString(port)).toString();
2414 if (exclusionList == null) {
2415 exclSpec = "";
2416 } else {
2417 StringBuilder listBuilder = new StringBuilder();
2418 boolean firstDomain = true;
2419 for (String exclDomain : exclusionList) {
2420 if (!firstDomain) {
2421 listBuilder = listBuilder.append(",");
2422 } else {
2423 firstDomain = false;
2424 }
2425 listBuilder = listBuilder.append(exclDomain.trim());
2426 }
2427 exclSpec = listBuilder.toString();
2428 }
Yuhao Zheng90704842014-02-28 17:22:45 -08002429 if (android.net.Proxy.validate(hostName, Integer.toString(port), exclSpec)
2430 != android.net.Proxy.PROXY_VALID)
2431 throw new IllegalArgumentException();
Oscar Montemayor69238c62010-08-03 10:51:06 -07002432 }
Fyodor Kupolovbdc58c62015-01-29 13:24:03 -08002433 return mService.setGlobalProxy(admin, hostSpec, exclSpec);
Oscar Montemayor69238c62010-08-03 10:51:06 -07002434 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07002435 throw e.rethrowFromSystemServer();
Oscar Montemayor69238c62010-08-03 10:51:06 -07002436 }
2437 }
2438 return null;
2439 }
2440
2441 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07002442 * Set a network-independent global HTTP proxy. This is not normally what you want for typical
2443 * HTTP proxies - they are generally network dependent. However if you're doing something
2444 * unusual like general internal filtering this may be useful. On a private network where the
2445 * proxy is not accessible, you may break HTTP using this.
2446 * <p>
2447 * This method requires the caller to be the device owner.
2448 * <p>
2449 * This proxy is only a recommendation and it is possible that some apps will ignore it.
Jason Monk03bc9912014-05-13 09:44:57 -04002450 *
Jason Monk03bc9912014-05-13 09:44:57 -04002451 * @see ProxyInfo
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07002452 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
2453 * @param proxyInfo The a {@link ProxyInfo} object defining the new global HTTP proxy. A
2454 * {@code null} value will clear the global HTTP proxy.
2455 * @throws SecurityException if {@code admin} is not the device owner.
Jason Monk03bc9912014-05-13 09:44:57 -04002456 */
Robin Lee25e26452015-06-02 09:56:29 -07002457 public void setRecommendedGlobalProxy(@NonNull ComponentName admin, @Nullable ProxyInfo
2458 proxyInfo) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01002459 throwIfParentInstance("setRecommendedGlobalProxy");
Jason Monk03bc9912014-05-13 09:44:57 -04002460 if (mService != null) {
2461 try {
2462 mService.setRecommendedGlobalProxy(admin, proxyInfo);
2463 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07002464 throw e.rethrowFromSystemServer();
Jason Monk03bc9912014-05-13 09:44:57 -04002465 }
2466 }
2467 }
2468
2469 /**
Oscar Montemayor69238c62010-08-03 10:51:06 -07002470 * Returns the component name setting the global proxy.
Robin Lee25e26452015-06-02 09:56:29 -07002471 * @return ComponentName object of the device admin that set the global proxy, or {@code null}
2472 * if no admin has set the proxy.
Andy Stadlerd2672722011-02-16 10:53:33 -08002473 * @hide
Oscar Montemayor69238c62010-08-03 10:51:06 -07002474 */
2475 public ComponentName getGlobalProxyAdmin() {
2476 if (mService != null) {
2477 try {
Makoto Onukicc4bbeb2015-09-17 10:28:24 -07002478 return mService.getGlobalProxyAdmin(myUserId());
Oscar Montemayor69238c62010-08-03 10:51:06 -07002479 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07002480 throw e.rethrowFromSystemServer();
Oscar Montemayor69238c62010-08-03 10:51:06 -07002481 }
2482 }
2483 return null;
2484 }
2485
2486 /**
Andy Stadler22dbfda2011-01-17 12:47:31 -08002487 * Result code for {@link #setStorageEncryption} and {@link #getStorageEncryptionStatus}:
Andy Stadler7b0f8f02011-01-12 14:59:52 -08002488 * indicating that encryption is not supported.
2489 */
2490 public static final int ENCRYPTION_STATUS_UNSUPPORTED = 0;
2491
2492 /**
Andy Stadler22dbfda2011-01-17 12:47:31 -08002493 * Result code for {@link #setStorageEncryption} and {@link #getStorageEncryptionStatus}:
Andy Stadler7b0f8f02011-01-12 14:59:52 -08002494 * indicating that encryption is supported, but is not currently active.
2495 */
2496 public static final int ENCRYPTION_STATUS_INACTIVE = 1;
2497
2498 /**
Robin Lee3795fb02015-02-16 14:17:23 +00002499 * Result code for {@link #getStorageEncryptionStatus}:
Andy Stadler7b0f8f02011-01-12 14:59:52 -08002500 * indicating that encryption is not currently active, but is currently
2501 * being activated. This is only reported by devices that support
2502 * encryption of data and only when the storage is currently
2503 * undergoing a process of becoming encrypted. A device that must reboot and/or wipe data
2504 * to become encrypted will never return this value.
2505 */
Andy Stadler22dbfda2011-01-17 12:47:31 -08002506 public static final int ENCRYPTION_STATUS_ACTIVATING = 2;
Andy Stadler7b0f8f02011-01-12 14:59:52 -08002507
2508 /**
Andy Stadler22dbfda2011-01-17 12:47:31 -08002509 * Result code for {@link #setStorageEncryption} and {@link #getStorageEncryptionStatus}:
Andy Stadler7b0f8f02011-01-12 14:59:52 -08002510 * indicating that encryption is active.
2511 */
Andy Stadler22dbfda2011-01-17 12:47:31 -08002512 public static final int ENCRYPTION_STATUS_ACTIVE = 3;
Andy Stadler7b0f8f02011-01-12 14:59:52 -08002513
2514 /**
Robin Lee3795fb02015-02-16 14:17:23 +00002515 * Result code for {@link #getStorageEncryptionStatus}:
2516 * indicating that encryption is active, but an encryption key has not
2517 * been set by the user.
2518 */
2519 public static final int ENCRYPTION_STATUS_ACTIVE_DEFAULT_KEY = 4;
2520
2521 /**
Makoto Onukid4c9e542016-02-25 18:17:30 -08002522 * Result code for {@link #getStorageEncryptionStatus}:
2523 * indicating that encryption is active and the encryption key is tied to the user.
2524 */
2525 public static final int ENCRYPTION_STATUS_ACTIVE_PER_USER = 5;
2526
2527 /**
Andy Stadler7b0f8f02011-01-12 14:59:52 -08002528 * Activity action: begin the process of encrypting data on the device. This activity should
2529 * be launched after using {@link #setStorageEncryption} to request encryption be activated.
2530 * After resuming from this activity, use {@link #getStorageEncryption}
2531 * to check encryption status. However, on some devices this activity may never return, as
2532 * it may trigger a reboot and in some cases a complete data wipe of the device.
2533 */
2534 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
2535 public static final String ACTION_START_ENCRYPTION
2536 = "android.app.action.START_ENCRYPTION";
Andy Stadler7b0f8f02011-01-12 14:59:52 -08002537 /**
Jim Millerb8ec4702012-08-31 17:19:10 -07002538 * Widgets are enabled in keyguard
2539 */
Jim Miller48b9b0d2012-09-19 23:16:50 -07002540 public static final int KEYGUARD_DISABLE_FEATURES_NONE = 0;
Jim Millerb8ec4702012-08-31 17:19:10 -07002541
2542 /**
Jim Miller50e62182014-04-23 17:25:00 -07002543 * Disable all keyguard widgets. Has no effect.
Jim Millerb8ec4702012-08-31 17:19:10 -07002544 */
Jim Miller48b9b0d2012-09-19 23:16:50 -07002545 public static final int KEYGUARD_DISABLE_WIDGETS_ALL = 1 << 0;
2546
2547 /**
2548 * Disable the camera on secure keyguard screens (e.g. PIN/Pattern/Password)
2549 */
2550 public static final int KEYGUARD_DISABLE_SECURE_CAMERA = 1 << 1;
2551
2552 /**
Jim Miller50e62182014-04-23 17:25:00 -07002553 * Disable showing all notifications on secure keyguard screens (e.g. PIN/Pattern/Password)
2554 */
2555 public static final int KEYGUARD_DISABLE_SECURE_NOTIFICATIONS = 1 << 2;
2556
2557 /**
2558 * Only allow redacted notifications on secure keyguard screens (e.g. PIN/Pattern/Password)
2559 */
2560 public static final int KEYGUARD_DISABLE_UNREDACTED_NOTIFICATIONS = 1 << 3;
2561
2562 /**
Adrian Roosa06d5ca2014-07-28 15:14:21 +02002563 * Ignore trust agent state on secure keyguard screens
Jim Miller50e62182014-04-23 17:25:00 -07002564 * (e.g. PIN/Pattern/Password).
2565 */
2566 public static final int KEYGUARD_DISABLE_TRUST_AGENTS = 1 << 4;
2567
2568 /**
Jim Miller06e34502014-07-17 14:46:05 -07002569 * Disable fingerprint sensor on keyguard secure screens (e.g. PIN/Pattern/Password).
2570 */
2571 public static final int KEYGUARD_DISABLE_FINGERPRINT = 1 << 5;
2572
2573 /**
Adrian Roos7f06eed2016-02-05 15:21:02 -08002574 * Disable text entry into notifications on secure keyguard screens (e.g. PIN/Pattern/Password).
2575 */
2576 public static final int KEYGUARD_DISABLE_REMOTE_INPUT = 1 << 6;
2577
2578 /**
Jim Miller35207742012-11-02 15:33:20 -07002579 * Disable all current and future keyguard customizations.
Jim Miller48b9b0d2012-09-19 23:16:50 -07002580 */
2581 public static final int KEYGUARD_DISABLE_FEATURES_ALL = 0x7fffffff;
Jim Millerb8ec4702012-08-31 17:19:10 -07002582
2583 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07002584 * Called by an application that is administering the device to request that the storage system
2585 * be encrypted.
2586 * <p>
2587 * When multiple device administrators attempt to control device encryption, the most secure,
2588 * supported setting will always be used. If any device administrator requests device
2589 * encryption, it will be enabled; Conversely, if a device administrator attempts to disable
2590 * device encryption while another device administrator has enabled it, the call to disable will
Andy Stadler7b0f8f02011-01-12 14:59:52 -08002591 * fail (most commonly returning {@link #ENCRYPTION_STATUS_ACTIVE}).
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07002592 * <p>
2593 * This policy controls encryption of the secure (application data) storage area. Data written
2594 * to other storage areas may or may not be encrypted, and this policy does not require or
2595 * control the encryption of any other storage areas. There is one exception: If
2596 * {@link android.os.Environment#isExternalStorageEmulated()} is {@code true}, then the
2597 * directory returned by {@link android.os.Environment#getExternalStorageDirectory()} must be
2598 * written to disk within the encrypted storage area.
2599 * <p>
2600 * Important Note: On some devices, it is possible to encrypt storage without requiring the user
2601 * to create a device PIN or Password. In this case, the storage is encrypted, but the
2602 * encryption key may not be fully secured. For maximum security, the administrator should also
2603 * require (and check for) a pattern, PIN, or password.
Andy Stadler7b0f8f02011-01-12 14:59:52 -08002604 *
2605 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
2606 * @param encrypt true to request encryption, false to release any previous request
Andy Stadler22dbfda2011-01-17 12:47:31 -08002607 * @return the new request status (for all active admins) - will be one of
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07002608 * {@link #ENCRYPTION_STATUS_UNSUPPORTED}, {@link #ENCRYPTION_STATUS_INACTIVE}, or
2609 * {@link #ENCRYPTION_STATUS_ACTIVE}. This is the value of the requests; Use
2610 * {@link #getStorageEncryptionStatus()} to query the actual device state.
2611 * @throws SecurityException if {@code admin} is not an active administrator or does not use
2612 * {@link DeviceAdminInfo#USES_ENCRYPTED_STORAGE}
Andy Stadler7b0f8f02011-01-12 14:59:52 -08002613 */
Robin Lee25e26452015-06-02 09:56:29 -07002614 public int setStorageEncryption(@NonNull ComponentName admin, boolean encrypt) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01002615 throwIfParentInstance("setStorageEncryption");
Andy Stadler7b0f8f02011-01-12 14:59:52 -08002616 if (mService != null) {
2617 try {
Fyodor Kupolovbdc58c62015-01-29 13:24:03 -08002618 return mService.setStorageEncryption(admin, encrypt);
Andy Stadler7b0f8f02011-01-12 14:59:52 -08002619 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07002620 throw e.rethrowFromSystemServer();
Andy Stadler7b0f8f02011-01-12 14:59:52 -08002621 }
2622 }
2623 return ENCRYPTION_STATUS_UNSUPPORTED;
2624 }
2625
2626 /**
2627 * Called by an application that is administering the device to
Andy Stadler22dbfda2011-01-17 12:47:31 -08002628 * determine the requested setting for secure storage.
Andy Stadler7b0f8f02011-01-12 14:59:52 -08002629 *
Andy Stadler22dbfda2011-01-17 12:47:31 -08002630 * @param admin Which {@link DeviceAdminReceiver} this request is associated with. If null,
2631 * this will return the requested encryption setting as an aggregate of all active
2632 * administrators.
2633 * @return true if the admin(s) are requesting encryption, false if not.
Andy Stadler7b0f8f02011-01-12 14:59:52 -08002634 */
Robin Lee25e26452015-06-02 09:56:29 -07002635 public boolean getStorageEncryption(@Nullable ComponentName admin) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01002636 throwIfParentInstance("getStorageEncryption");
Andy Stadler7b0f8f02011-01-12 14:59:52 -08002637 if (mService != null) {
2638 try {
Makoto Onukicc4bbeb2015-09-17 10:28:24 -07002639 return mService.getStorageEncryption(admin, myUserId());
Andy Stadler7b0f8f02011-01-12 14:59:52 -08002640 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07002641 throw e.rethrowFromSystemServer();
Andy Stadler7b0f8f02011-01-12 14:59:52 -08002642 }
2643 }
Andy Stadler22dbfda2011-01-17 12:47:31 -08002644 return false;
2645 }
2646
2647 /**
2648 * Called by an application that is administering the device to
2649 * determine the current encryption status of the device.
2650 *
2651 * Depending on the returned status code, the caller may proceed in different
2652 * ways. If the result is {@link #ENCRYPTION_STATUS_UNSUPPORTED}, the
2653 * storage system does not support encryption. If the
2654 * result is {@link #ENCRYPTION_STATUS_INACTIVE}, use {@link
2655 * #ACTION_START_ENCRYPTION} to begin the process of encrypting or decrypting the
Robin Lee3795fb02015-02-16 14:17:23 +00002656 * storage. If the result is {@link #ENCRYPTION_STATUS_ACTIVE_DEFAULT_KEY}, the
2657 * storage system has enabled encryption but no password is set so further action
2658 * may be required. If the result is {@link #ENCRYPTION_STATUS_ACTIVATING} or
Andy Stadler22dbfda2011-01-17 12:47:31 -08002659 * {@link #ENCRYPTION_STATUS_ACTIVE}, no further action is required.
2660 *
Robin Lee7e678712014-07-24 16:41:31 +01002661 * @return current status of encryption. The value will be one of
Andy Stadler22dbfda2011-01-17 12:47:31 -08002662 * {@link #ENCRYPTION_STATUS_UNSUPPORTED}, {@link #ENCRYPTION_STATUS_INACTIVE},
Robin Lee3795fb02015-02-16 14:17:23 +00002663 * {@link #ENCRYPTION_STATUS_ACTIVATING}, {@link #ENCRYPTION_STATUS_ACTIVE_DEFAULT_KEY},
2664 * or {@link #ENCRYPTION_STATUS_ACTIVE}.
Andy Stadler22dbfda2011-01-17 12:47:31 -08002665 */
2666 public int getStorageEncryptionStatus() {
Benjamin Franzbc33c822016-04-15 08:57:52 +01002667 throwIfParentInstance("getStorageEncryptionStatus");
Makoto Onukicc4bbeb2015-09-17 10:28:24 -07002668 return getStorageEncryptionStatus(myUserId());
Amith Yamasani599dd7c2012-09-14 23:20:08 -07002669 }
2670
2671 /** @hide per-user version */
2672 public int getStorageEncryptionStatus(int userHandle) {
Andy Stadler22dbfda2011-01-17 12:47:31 -08002673 if (mService != null) {
2674 try {
Makoto Onukid4c9e542016-02-25 18:17:30 -08002675 return mService.getStorageEncryptionStatus(mContext.getPackageName(), userHandle);
Andy Stadler22dbfda2011-01-17 12:47:31 -08002676 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07002677 throw e.rethrowFromSystemServer();
Andy Stadler22dbfda2011-01-17 12:47:31 -08002678 }
2679 }
Andy Stadler7b0f8f02011-01-12 14:59:52 -08002680 return ENCRYPTION_STATUS_UNSUPPORTED;
2681 }
2682
2683 /**
Robin Lee2f7e1e42016-03-21 10:50:01 +00002684 * Mark a CA certificate as approved by the device user. This means that they have been notified
2685 * of the installation, were made aware of the risks, viewed the certificate and still wanted to
2686 * keep the certificate on the device.
2687 *
2688 * Calling with {@param approval} as {@code true} will cancel any ongoing warnings related to
2689 * this certificate.
2690 *
2691 * @hide
2692 */
2693 public boolean approveCaCert(String alias, int userHandle, boolean approval) {
2694 if (mService != null) {
2695 try {
2696 return mService.approveCaCert(alias, userHandle, approval);
2697 } catch (RemoteException e) {
2698 throw e.rethrowFromSystemServer();
2699 }
2700 }
2701 return false;
2702 }
2703
2704 /**
2705 * Check whether a CA certificate has been approved by the device user.
2706 *
2707 * @hide
2708 */
2709 public boolean isCaCertApproved(String alias, int userHandle) {
2710 if (mService != null) {
2711 try {
2712 return mService.isCaCertApproved(alias, userHandle);
2713 } catch (RemoteException e) {
2714 throw e.rethrowFromSystemServer();
2715 }
2716 }
2717 return false;
2718 }
2719
2720 /**
Robin Lee7e678712014-07-24 16:41:31 +01002721 * Installs the given certificate as a user CA.
2722 *
Robin Lee25e26452015-06-02 09:56:29 -07002723 * @param admin Which {@link DeviceAdminReceiver} this request is associated with, or
2724 * {@code null} if calling from a delegated certificate installer.
Robin Lee7e678712014-07-24 16:41:31 +01002725 * @param certBuffer encoded form of the certificate to install.
Maggie Benthallda51e682013-08-08 22:35:44 -04002726 *
2727 * @return false if the certBuffer cannot be parsed or installation is
Robin Lee7e678712014-07-24 16:41:31 +01002728 * interrupted, true otherwise.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07002729 * @throws SecurityException if {@code admin} is not {@code null} and not a device or profile
2730 * owner.
Maggie Benthallda51e682013-08-08 22:35:44 -04002731 */
Robin Lee25e26452015-06-02 09:56:29 -07002732 public boolean installCaCert(@Nullable ComponentName admin, byte[] certBuffer) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01002733 throwIfParentInstance("installCaCert");
Maggie Benthallda51e682013-08-08 22:35:44 -04002734 if (mService != null) {
2735 try {
Robin Lee7e678712014-07-24 16:41:31 +01002736 return mService.installCaCert(admin, certBuffer);
Maggie Benthallda51e682013-08-08 22:35:44 -04002737 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07002738 throw e.rethrowFromSystemServer();
Maggie Benthallda51e682013-08-08 22:35:44 -04002739 }
2740 }
2741 return false;
2742 }
2743
2744 /**
Robin Lee7e678712014-07-24 16:41:31 +01002745 * Uninstalls the given certificate from trusted user CAs, if present.
2746 *
Robin Lee25e26452015-06-02 09:56:29 -07002747 * @param admin Which {@link DeviceAdminReceiver} this request is associated with, or
2748 * {@code null} if calling from a delegated certificate installer.
Robin Lee7e678712014-07-24 16:41:31 +01002749 * @param certBuffer encoded form of the certificate to remove.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07002750 * @throws SecurityException if {@code admin} is not {@code null} and not a device or profile
2751 * owner.
Maggie Benthallda51e682013-08-08 22:35:44 -04002752 */
Robin Lee25e26452015-06-02 09:56:29 -07002753 public void uninstallCaCert(@Nullable ComponentName admin, byte[] certBuffer) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01002754 throwIfParentInstance("uninstallCaCert");
Maggie Benthallda51e682013-08-08 22:35:44 -04002755 if (mService != null) {
2756 try {
Robin Lee306fe082014-06-19 14:04:24 +00002757 final String alias = getCaCertAlias(certBuffer);
Robin Lee83881bd2015-06-09 16:04:38 -07002758 mService.uninstallCaCerts(admin, new String[] {alias});
Robin Lee306fe082014-06-19 14:04:24 +00002759 } catch (CertificateException e) {
2760 Log.w(TAG, "Unable to parse certificate", e);
Maggie Benthallda51e682013-08-08 22:35:44 -04002761 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07002762 throw e.rethrowFromSystemServer();
Maggie Benthallda51e682013-08-08 22:35:44 -04002763 }
2764 }
2765 }
2766
2767 /**
Robin Lee7e678712014-07-24 16:41:31 +01002768 * Returns all CA certificates that are currently trusted, excluding system CA certificates.
2769 * If a user has installed any certificates by other means than device policy these will be
2770 * included too.
2771 *
Robin Lee25e26452015-06-02 09:56:29 -07002772 * @param admin Which {@link DeviceAdminReceiver} this request is associated with, or
2773 * {@code null} if calling from a delegated certificate installer.
Robin Lee7e678712014-07-24 16:41:31 +01002774 * @return a List of byte[] arrays, each encoding one user CA certificate.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07002775 * @throws SecurityException if {@code admin} is not {@code null} and not a device or profile
2776 * owner.
Maggie Benthallda51e682013-08-08 22:35:44 -04002777 */
Robin Lee25e26452015-06-02 09:56:29 -07002778 public List<byte[]> getInstalledCaCerts(@Nullable ComponentName admin) {
Robin Lee7e678712014-07-24 16:41:31 +01002779 List<byte[]> certs = new ArrayList<byte[]>();
Benjamin Franzbc33c822016-04-15 08:57:52 +01002780 throwIfParentInstance("getInstalledCaCerts");
Esteban Talavera808f6ef2014-08-28 17:15:54 +01002781 if (mService != null) {
Robin Lee7e678712014-07-24 16:41:31 +01002782 try {
Esteban Talavera808f6ef2014-08-28 17:15:54 +01002783 mService.enforceCanManageCaCerts(admin);
2784 final TrustedCertificateStore certStore = new TrustedCertificateStore();
2785 for (String alias : certStore.userAliases()) {
2786 try {
2787 certs.add(certStore.getCertificate(alias).getEncoded());
2788 } catch (CertificateException ce) {
2789 Log.w(TAG, "Could not encode certificate: " + alias, ce);
2790 }
2791 }
2792 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07002793 throw re.rethrowFromSystemServer();
Robin Lee7e678712014-07-24 16:41:31 +01002794 }
2795 }
2796 return certs;
Maggie Benthallda51e682013-08-08 22:35:44 -04002797 }
2798
2799 /**
Robin Lee7e678712014-07-24 16:41:31 +01002800 * Uninstalls all custom trusted CA certificates from the profile. Certificates installed by
2801 * means other than device policy will also be removed, except for system CA certificates.
2802 *
Robin Lee25e26452015-06-02 09:56:29 -07002803 * @param admin Which {@link DeviceAdminReceiver} this request is associated with, or
2804 * {@code null} if calling from a delegated certificate installer.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07002805 * @throws SecurityException if {@code admin} is not {@code null} and not a device or profile
2806 * owner.
Robin Lee7e678712014-07-24 16:41:31 +01002807 */
Robin Lee25e26452015-06-02 09:56:29 -07002808 public void uninstallAllUserCaCerts(@Nullable ComponentName admin) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01002809 throwIfParentInstance("uninstallAllUserCaCerts");
Robin Lee7e678712014-07-24 16:41:31 +01002810 if (mService != null) {
Robin Lee83881bd2015-06-09 16:04:38 -07002811 try {
2812 mService.uninstallCaCerts(admin, new TrustedCertificateStore().userAliases()
2813 .toArray(new String[0]));
2814 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07002815 throw re.rethrowFromSystemServer();
Robin Lee7e678712014-07-24 16:41:31 +01002816 }
2817 }
2818 }
2819
2820 /**
2821 * Returns whether this certificate is installed as a trusted CA.
2822 *
Robin Lee25e26452015-06-02 09:56:29 -07002823 * @param admin Which {@link DeviceAdminReceiver} this request is associated with, or
2824 * {@code null} if calling from a delegated certificate installer.
Robin Lee7e678712014-07-24 16:41:31 +01002825 * @param certBuffer encoded form of the certificate to look up.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07002826 * @throws SecurityException if {@code admin} is not {@code null} and not a device or profile
2827 * owner.
Maggie Benthallda51e682013-08-08 22:35:44 -04002828 */
Robin Lee25e26452015-06-02 09:56:29 -07002829 public boolean hasCaCertInstalled(@Nullable ComponentName admin, byte[] certBuffer) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01002830 throwIfParentInstance("hasCaCertInstalled");
Esteban Talavera808f6ef2014-08-28 17:15:54 +01002831 if (mService != null) {
2832 try {
2833 mService.enforceCanManageCaCerts(admin);
2834 return getCaCertAlias(certBuffer) != null;
2835 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07002836 throw re.rethrowFromSystemServer();
Esteban Talavera808f6ef2014-08-28 17:15:54 +01002837 } catch (CertificateException ce) {
2838 Log.w(TAG, "Could not parse certificate", ce);
2839 }
Maggie Benthallda51e682013-08-08 22:35:44 -04002840 }
2841 return false;
2842 }
2843
2844 /**
Robin Leece3399f2016-02-24 12:08:32 +00002845 * Called by a device or profile owner, or delegated certificate installer, to install a
2846 * certificate and corresponding private key. All apps within the profile will be able to access
2847 * the certificate and use the private key, given direct user approval.
2848 *
2849 * <p>Access to the installed credentials will not be granted to the caller of this API without
2850 * direct user approval. This is for security - should a certificate installer become
2851 * compromised, certificates it had already installed will be protected.
2852 *
2853 * <p>If the installer must have access to the credentials, call
Rubin Xub4365912016-03-23 12:13:22 +00002854 * {@link #installKeyPair(ComponentName, PrivateKey, Certificate[], String, boolean)} instead.
Bernhard Bauer26408cc2014-09-08 14:07:31 +01002855 *
Robin Lee25e26452015-06-02 09:56:29 -07002856 * @param admin Which {@link DeviceAdminReceiver} this request is associated with, or
2857 * {@code null} if calling from a delegated certificate installer.
Bernhard Bauer26408cc2014-09-08 14:07:31 +01002858 * @param privKey The private key to install.
2859 * @param cert The certificate to install.
2860 * @param alias The private key alias under which to install the certificate. If a certificate
2861 * with that alias already exists, it will be overwritten.
2862 * @return {@code true} if the keys were installed, {@code false} otherwise.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07002863 * @throws SecurityException if {@code admin} is not {@code null} and not a device or profile
2864 * owner.
Bernhard Bauer26408cc2014-09-08 14:07:31 +01002865 */
Robin Leefbc65642015-08-03 16:21:22 +01002866 public boolean installKeyPair(@Nullable ComponentName admin, @NonNull PrivateKey privKey,
2867 @NonNull Certificate cert, @NonNull String alias) {
Rubin Xub4365912016-03-23 12:13:22 +00002868 return installKeyPair(admin, privKey, new Certificate[] {cert}, alias, false);
Robin Leece3399f2016-02-24 12:08:32 +00002869 }
2870
2871 /**
2872 * Called by a device or profile owner, or delegated certificate installer, to install a
Rubin Xub4365912016-03-23 12:13:22 +00002873 * certificate chain and corresponding private key for the leaf certificate. All apps within the
2874 * profile will be able to access the certificate chain and use the private key, given direct
2875 * user approval.
Robin Leece3399f2016-02-24 12:08:32 +00002876 *
Robin Leea1b290e2016-03-09 14:38:36 +00002877 * <p>The caller of this API may grant itself access to the certificate and private key
2878 * immediately, without user approval. It is a best practice not to request this unless strictly
2879 * necessary since it opens up additional security vulnerabilities.
Robin Leece3399f2016-02-24 12:08:32 +00002880 *
2881 * @param admin Which {@link DeviceAdminReceiver} this request is associated with, or
Robin Leea1b290e2016-03-09 14:38:36 +00002882 * {@code null} if calling from a delegated certificate installer.
Robin Leece3399f2016-02-24 12:08:32 +00002883 * @param privKey The private key to install.
Rubin Xub4365912016-03-23 12:13:22 +00002884 * @param certs The certificate chain to install. The chain should start with the leaf
2885 * certificate and include the chain of trust in order. This will be returned by
2886 * {@link android.security.KeyChain#getCertificateChain}.
Robin Leece3399f2016-02-24 12:08:32 +00002887 * @param alias The private key alias under which to install the certificate. If a certificate
Robin Leea1b290e2016-03-09 14:38:36 +00002888 * with that alias already exists, it will be overwritten.
Robin Leece3399f2016-02-24 12:08:32 +00002889 * @param requestAccess {@code true} to request that the calling app be granted access to the
Robin Leea1b290e2016-03-09 14:38:36 +00002890 * credentials immediately. Otherwise, access to the credentials will be gated by user
2891 * approval.
Robin Leece3399f2016-02-24 12:08:32 +00002892 * @return {@code true} if the keys were installed, {@code false} otherwise.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07002893 * @throws SecurityException if {@code admin} is not {@code null} and not a device or profile
2894 * owner.
Rubin Xub4365912016-03-23 12:13:22 +00002895 * @see android.security.KeyChain#getCertificateChain
Robin Leece3399f2016-02-24 12:08:32 +00002896 */
2897 public boolean installKeyPair(@Nullable ComponentName admin, @NonNull PrivateKey privKey,
Rubin Xub4365912016-03-23 12:13:22 +00002898 @NonNull Certificate[] certs, @NonNull String alias, boolean requestAccess) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01002899 throwIfParentInstance("installKeyPair");
Bernhard Bauer26408cc2014-09-08 14:07:31 +01002900 try {
Rubin Xub4365912016-03-23 12:13:22 +00002901 final byte[] pemCert = Credentials.convertToPem(certs[0]);
2902 byte[] pemChain = null;
2903 if (certs.length > 1) {
2904 pemChain = Credentials.convertToPem(Arrays.copyOfRange(certs, 1, certs.length));
2905 }
Robin Lee0d5ccb72014-09-12 17:41:44 +01002906 final byte[] pkcs8Key = KeyFactory.getInstance(privKey.getAlgorithm())
2907 .getKeySpec(privKey, PKCS8EncodedKeySpec.class).getEncoded();
Rubin Xub4365912016-03-23 12:13:22 +00002908 return mService.installKeyPair(admin, pkcs8Key, pemCert, pemChain, alias,
2909 requestAccess);
Bernhard Bauer26408cc2014-09-08 14:07:31 +01002910 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07002911 throw e.rethrowFromSystemServer();
Robin Lee0d5ccb72014-09-12 17:41:44 +01002912 } catch (NoSuchAlgorithmException | InvalidKeySpecException e) {
2913 Log.w(TAG, "Failed to obtain private key material", e);
2914 } catch (CertificateException | IOException e) {
2915 Log.w(TAG, "Could not pem-encode certificate", e);
Bernhard Bauer26408cc2014-09-08 14:07:31 +01002916 }
2917 return false;
2918 }
2919
2920 /**
Robin Leea1b290e2016-03-09 14:38:36 +00002921 * Called by a device or profile owner, or delegated certificate installer, to remove a
2922 * certificate and private key pair installed under a given alias.
Robin Leefbc65642015-08-03 16:21:22 +01002923 *
2924 * @param admin Which {@link DeviceAdminReceiver} this request is associated with, or
Robin Leea1b290e2016-03-09 14:38:36 +00002925 * {@code null} if calling from a delegated certificate installer.
Robin Leefbc65642015-08-03 16:21:22 +01002926 * @param alias The private key alias under which the certificate is installed.
Robin Leea1b290e2016-03-09 14:38:36 +00002927 * @return {@code true} if the private key alias no longer exists, {@code false} otherwise.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07002928 * @throws SecurityException if {@code admin} is not {@code null} and not a device or profile
2929 * owner.
Robin Leefbc65642015-08-03 16:21:22 +01002930 */
2931 public boolean removeKeyPair(@Nullable ComponentName admin, @NonNull String alias) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01002932 throwIfParentInstance("removeKeyPair");
Robin Leefbc65642015-08-03 16:21:22 +01002933 try {
2934 return mService.removeKeyPair(admin, alias);
2935 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07002936 throw e.rethrowFromSystemServer();
Robin Leefbc65642015-08-03 16:21:22 +01002937 }
Robin Leefbc65642015-08-03 16:21:22 +01002938 }
2939
2940 /**
Robin Lee25e26452015-06-02 09:56:29 -07002941 * @return the alias of a given CA certificate in the certificate store, or {@code null} if it
Robin Lee306fe082014-06-19 14:04:24 +00002942 * doesn't exist.
2943 */
2944 private static String getCaCertAlias(byte[] certBuffer) throws CertificateException {
2945 final CertificateFactory certFactory = CertificateFactory.getInstance("X.509");
2946 final X509Certificate cert = (X509Certificate) certFactory.generateCertificate(
2947 new ByteArrayInputStream(certBuffer));
2948 return new TrustedCertificateStore().getCertificateAlias(cert);
2949 }
2950
2951 /**
Rubin Xuec32b562015-03-03 17:34:05 +00002952 * Called by a profile owner or device owner to grant access to privileged certificate
Rubin Xuacdc1832015-04-02 12:40:20 +01002953 * manipulation APIs to a third-party certificate installer app. Granted APIs include
Rubin Xuec32b562015-03-03 17:34:05 +00002954 * {@link #getInstalledCaCerts}, {@link #hasCaCertInstalled}, {@link #installCaCert},
Rubin Xuacdc1832015-04-02 12:40:20 +01002955 * {@link #uninstallCaCert}, {@link #uninstallAllUserCaCerts} and {@link #installKeyPair}.
Rubin Xuec32b562015-03-03 17:34:05 +00002956 * <p>
2957 * Delegated certificate installer is a per-user state. The delegated access is persistent until
2958 * it is later cleared by calling this method with a null value or uninstallling the certificate
2959 * installer.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07002960 * <p>
Rubin Xuf03d0a62016-02-10 14:54:15 +00002961 * <b>Note:</b>Starting from {@link android.os.Build.VERSION_CODES#N}, if the caller
2962 * application's target SDK version is {@link android.os.Build.VERSION_CODES#N} or newer, the
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07002963 * supplied certificate installer package must be installed when calling this API, otherwise an
2964 * {@link IllegalArgumentException} will be thrown.
Rubin Xuec32b562015-03-03 17:34:05 +00002965 *
Robin Lee25e26452015-06-02 09:56:29 -07002966 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
Rubin Xuec32b562015-03-03 17:34:05 +00002967 * @param installerPackage The package name of the certificate installer which will be given
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07002968 * access. If {@code null} is given the current package will be cleared.
2969 * @throws SecurityException if {@code admin} is not a device or a profile owner.
Rubin Xuec32b562015-03-03 17:34:05 +00002970 */
Robin Lee25e26452015-06-02 09:56:29 -07002971 public void setCertInstallerPackage(@NonNull ComponentName admin, @Nullable String
2972 installerPackage) throws SecurityException {
Benjamin Franzbc33c822016-04-15 08:57:52 +01002973 throwIfParentInstance("setCertInstallerPackage");
Rubin Xuec32b562015-03-03 17:34:05 +00002974 if (mService != null) {
2975 try {
Robin Lee25e26452015-06-02 09:56:29 -07002976 mService.setCertInstallerPackage(admin, installerPackage);
Rubin Xuec32b562015-03-03 17:34:05 +00002977 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07002978 throw e.rethrowFromSystemServer();
Rubin Xuec32b562015-03-03 17:34:05 +00002979 }
2980 }
2981 }
2982
2983 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07002984 * Called by a profile owner or device owner to retrieve the certificate installer for the user.
2985 * null if none is set.
Rubin Xuec32b562015-03-03 17:34:05 +00002986 *
Robin Lee25e26452015-06-02 09:56:29 -07002987 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07002988 * @return The package name of the current delegated certificate installer, or {@code null} if
2989 * none is set.
2990 * @throws SecurityException if {@code admin} is not a device or a profile owner.
Rubin Xuec32b562015-03-03 17:34:05 +00002991 */
Robin Lee25e26452015-06-02 09:56:29 -07002992 public String getCertInstallerPackage(@NonNull ComponentName admin) throws SecurityException {
Benjamin Franzbc33c822016-04-15 08:57:52 +01002993 throwIfParentInstance("getCertInstallerPackage");
Rubin Xuec32b562015-03-03 17:34:05 +00002994 if (mService != null) {
2995 try {
Robin Lee25e26452015-06-02 09:56:29 -07002996 return mService.getCertInstallerPackage(admin);
Rubin Xuec32b562015-03-03 17:34:05 +00002997 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07002998 throw e.rethrowFromSystemServer();
Rubin Xuec32b562015-03-03 17:34:05 +00002999 }
3000 }
3001 return null;
3002 }
3003
3004 /**
Robin Lee244ce8e2016-01-05 18:03:46 +00003005 * Called by a device or profile owner to configure an always-on VPN connection through a
Robin Leedc679712016-05-03 13:23:03 +01003006 * specific application for the current user.
3007 *
3008 * @deprecated this version only exists for compability with previous developer preview builds.
3009 * TODO: delete once there are no longer any live references.
3010 * @hide
3011 */
Aurimas Liutikas514c5ef2016-05-24 15:22:55 -07003012 @Deprecated
Robin Leedc679712016-05-03 13:23:03 +01003013 public void setAlwaysOnVpnPackage(@NonNull ComponentName admin, @Nullable String vpnPackage)
3014 throws NameNotFoundException, UnsupportedOperationException {
3015 setAlwaysOnVpnPackage(admin, vpnPackage, /* lockdownEnabled */ true);
3016 }
3017
3018 /**
3019 * Called by a device or profile owner to configure an always-on VPN connection through a
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07003020 * specific application for the current user. This connection is automatically granted and
3021 * persisted after a reboot.
3022 * <p>
3023 * The designated package should declare a {@link android.net.VpnService} in its manifest
3024 * guarded by {@link android.Manifest.permission#BIND_VPN_SERVICE}, otherwise the call will
3025 * fail.
Robin Lee244ce8e2016-01-05 18:03:46 +00003026 *
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07003027 * @param vpnPackage The package name for an installed VPN app on the device, or {@code null} to
Robin Leedc679712016-05-03 13:23:03 +01003028 * remove an existing always-on VPN configuration.
3029 * @param lockdownEnabled {@code true} to disallow networking when the VPN is not connected or
3030 * {@code false} otherwise. This carries the risk that any failure of the VPN provider
3031 * could break networking for all apps. This has no effect when clearing.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07003032 * @return {@code true} if the package is set as always-on VPN controller; {@code false}
3033 * otherwise.
3034 * @throws SecurityException if {@code admin} is not a device or a profile owner.
Robin Leeee5eb932016-04-05 16:27:15 +01003035 * @throws NameNotFoundException if {@code vpnPackage} is not installed.
3036 * @throws UnsupportedOperationException if {@code vpnPackage} exists but does not support being
3037 * set as always-on, or if always-on VPN is not available.
Robin Lee244ce8e2016-01-05 18:03:46 +00003038 */
Robin Leedc679712016-05-03 13:23:03 +01003039 public void setAlwaysOnVpnPackage(@NonNull ComponentName admin, @Nullable String vpnPackage,
3040 boolean lockdownEnabled)
Robin Leeee5eb932016-04-05 16:27:15 +01003041 throws NameNotFoundException, UnsupportedOperationException {
Benjamin Franzbc33c822016-04-15 08:57:52 +01003042 throwIfParentInstance("setAlwaysOnVpnPackage");
Robin Lee244ce8e2016-01-05 18:03:46 +00003043 if (mService != null) {
3044 try {
Robin Leedc679712016-05-03 13:23:03 +01003045 if (!mService.setAlwaysOnVpnPackage(admin, vpnPackage, lockdownEnabled)) {
Robin Leeee5eb932016-04-05 16:27:15 +01003046 throw new NameNotFoundException(vpnPackage);
3047 }
Robin Lee244ce8e2016-01-05 18:03:46 +00003048 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07003049 throw e.rethrowFromSystemServer();
Robin Lee244ce8e2016-01-05 18:03:46 +00003050 }
3051 }
Robin Lee244ce8e2016-01-05 18:03:46 +00003052 }
3053
3054 /**
3055 * Called by a device or profile owner to read the name of the package administering an
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07003056 * always-on VPN connection for the current user. If there is no such package, or the always-on
3057 * VPN is provided by the system instead of by an application, {@code null} will be returned.
Robin Lee244ce8e2016-01-05 18:03:46 +00003058 *
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07003059 * @return Package name of VPN controller responsible for always-on VPN, or {@code null} if none
3060 * is set.
3061 * @throws SecurityException if {@code admin} is not a device or a profile owner.
Robin Lee244ce8e2016-01-05 18:03:46 +00003062 */
3063 public String getAlwaysOnVpnPackage(@NonNull ComponentName admin) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01003064 throwIfParentInstance("getAlwaysOnVpnPackage");
Robin Lee244ce8e2016-01-05 18:03:46 +00003065 if (mService != null) {
3066 try {
3067 return mService.getAlwaysOnVpnPackage(admin);
3068 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07003069 throw e.rethrowFromSystemServer();
Robin Lee244ce8e2016-01-05 18:03:46 +00003070 }
3071 }
3072 return null;
3073 }
3074
3075 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07003076 * Called by an application that is administering the device to disable all cameras on the
3077 * device, for this user. After setting this, no applications running as this user will be able
3078 * to access any cameras on the device.
3079 * <p>
3080 * If the caller is device owner, then the restriction will be applied to all users.
3081 * <p>
3082 * The calling device admin must have requested
3083 * {@link DeviceAdminInfo#USES_POLICY_DISABLE_CAMERA} to be able to call this method; if it has
3084 * not, a security exception will be thrown.
Ben Komalo2447edd2011-05-09 16:05:33 -07003085 *
3086 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
3087 * @param disabled Whether or not the camera should be disabled.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07003088 * @throws SecurityException if {@code admin} is not an active administrator or does not use
3089 * {@link DeviceAdminInfo#USES_POLICY_DISABLE_CAMERA}.
Ben Komalo2447edd2011-05-09 16:05:33 -07003090 */
Robin Lee25e26452015-06-02 09:56:29 -07003091 public void setCameraDisabled(@NonNull ComponentName admin, boolean disabled) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01003092 throwIfParentInstance("setCameraDisabled");
Ben Komalo2447edd2011-05-09 16:05:33 -07003093 if (mService != null) {
3094 try {
Fyodor Kupolovbdc58c62015-01-29 13:24:03 -08003095 mService.setCameraDisabled(admin, disabled);
Ben Komalo2447edd2011-05-09 16:05:33 -07003096 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07003097 throw e.rethrowFromSystemServer();
Ben Komalo2447edd2011-05-09 16:05:33 -07003098 }
3099 }
3100 }
3101
3102 /**
Amith Yamasani242f4b12014-10-14 16:06:13 -07003103 * Determine whether or not the device's cameras have been disabled for this user,
Makoto Onuki32b30572015-12-11 14:29:51 -08003104 * either by the calling admin, if specified, or all admins.
Robin Lee25e26452015-06-02 09:56:29 -07003105 * @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 -07003106 * have disabled the camera
3107 */
Robin Lee25e26452015-06-02 09:56:29 -07003108 public boolean getCameraDisabled(@Nullable ComponentName admin) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01003109 throwIfParentInstance("getCameraDisabled");
Makoto Onukicc4bbeb2015-09-17 10:28:24 -07003110 return getCameraDisabled(admin, myUserId());
Amith Yamasani599dd7c2012-09-14 23:20:08 -07003111 }
3112
3113 /** @hide per-user version */
Robin Lee25e26452015-06-02 09:56:29 -07003114 public boolean getCameraDisabled(@Nullable ComponentName admin, int userHandle) {
Ben Komalo2447edd2011-05-09 16:05:33 -07003115 if (mService != null) {
3116 try {
Amith Yamasani599dd7c2012-09-14 23:20:08 -07003117 return mService.getCameraDisabled(admin, userHandle);
Ben Komalo2447edd2011-05-09 16:05:33 -07003118 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07003119 throw e.rethrowFromSystemServer();
Ben Komalo2447edd2011-05-09 16:05:33 -07003120 }
3121 }
3122 return false;
3123 }
3124
3125 /**
Michal Karpinski3fc437e2015-12-15 10:09:00 +00003126 * Called by a device owner to request a bugreport.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07003127 * <p>
3128 * There must be only one user on the device, managed by the device owner. Otherwise a
3129 * {@link SecurityException} will be thrown.
Michal Karpinski3fc437e2015-12-15 10:09:00 +00003130 *
3131 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07003132 * @return {@code true} if the bugreport collection started successfully, or {@code false} if it
3133 * wasn't triggered because a previous bugreport operation is still active (either the
3134 * bugreport is still running or waiting for the user to share or decline)
3135 * @throws SecurityException if {@code admin} is not a device owner, or if there are users other
3136 * than the one managed by the device owner.
Michal Karpinski3fc437e2015-12-15 10:09:00 +00003137 */
3138 public boolean requestBugreport(@NonNull ComponentName admin) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01003139 throwIfParentInstance("requestBugreport");
Michal Karpinski3fc437e2015-12-15 10:09:00 +00003140 if (mService != null) {
3141 try {
3142 return mService.requestBugreport(admin);
3143 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07003144 throw e.rethrowFromSystemServer();
Michal Karpinski3fc437e2015-12-15 10:09:00 +00003145 }
3146 }
3147 return false;
3148 }
3149
3150 /**
Fyodor Kupolovcd86ebf2015-09-29 17:06:50 -07003151 * Determine whether or not creating a guest user has been disabled for the device
3152 *
3153 * @hide
3154 */
3155 public boolean getGuestUserDisabled(@Nullable ComponentName admin) {
3156 // Currently guest users can always be created if multi-user is enabled
3157 // TODO introduce a policy for guest user creation
3158 return false;
3159 }
3160
3161 /**
Esteban Talavera1aee98f2014-08-21 14:03:55 +01003162 * Called by a device/profile owner to set whether the screen capture is disabled. Disabling
3163 * screen capture also prevents the content from being shown on display devices that do not have
3164 * a secure video output. See {@link android.view.Display#FLAG_SECURE} for more details about
3165 * secure surfaces and secure displays.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07003166 * <p>
3167 * The calling device admin must be a device or profile owner. If it is not, a security
3168 * exception will be thrown.
3169 * <p>
3170 * From version {@link android.os.Build.VERSION_CODES#M} disabling screen capture also blocks
3171 * assist requests for all activities of the relevant user.
Benjamin Franzc200f442015-06-25 18:20:04 +01003172 *
Sander Alewijnsed2a1eec2014-07-09 12:57:05 +01003173 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
Sander Alewijnse0ced6272014-08-26 11:18:26 +01003174 * @param disabled Whether screen capture is disabled or not.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07003175 * @throws SecurityException if {@code admin} is not a device or profile owner.
Sander Alewijnsed2a1eec2014-07-09 12:57:05 +01003176 */
Robin Lee25e26452015-06-02 09:56:29 -07003177 public void setScreenCaptureDisabled(@NonNull ComponentName admin, boolean disabled) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01003178 throwIfParentInstance("setScreenCaptureDisabled");
Sander Alewijnsed2a1eec2014-07-09 12:57:05 +01003179 if (mService != null) {
3180 try {
Fyodor Kupolovbdc58c62015-01-29 13:24:03 -08003181 mService.setScreenCaptureDisabled(admin, disabled);
Sander Alewijnsed2a1eec2014-07-09 12:57:05 +01003182 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07003183 throw e.rethrowFromSystemServer();
Sander Alewijnsed2a1eec2014-07-09 12:57:05 +01003184 }
3185 }
3186 }
3187
3188 /**
Makoto Onuki32b30572015-12-11 14:29:51 -08003189 * Determine whether or not screen capture has been disabled by the calling
Sander Alewijnsed2a1eec2014-07-09 12:57:05 +01003190 * admin, if specified, or all admins.
Robin Lee25e26452015-06-02 09:56:29 -07003191 * @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 +01003192 * have disabled screen capture.
3193 */
Robin Lee25e26452015-06-02 09:56:29 -07003194 public boolean getScreenCaptureDisabled(@Nullable ComponentName admin) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01003195 throwIfParentInstance("getScreenCaptureDisabled");
Makoto Onukicc4bbeb2015-09-17 10:28:24 -07003196 return getScreenCaptureDisabled(admin, myUserId());
Sander Alewijnsed2a1eec2014-07-09 12:57:05 +01003197 }
3198
3199 /** @hide per-user version */
Robin Lee25e26452015-06-02 09:56:29 -07003200 public boolean getScreenCaptureDisabled(@Nullable ComponentName admin, int userHandle) {
Sander Alewijnsed2a1eec2014-07-09 12:57:05 +01003201 if (mService != null) {
3202 try {
3203 return mService.getScreenCaptureDisabled(admin, userHandle);
3204 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07003205 throw e.rethrowFromSystemServer();
Sander Alewijnsed2a1eec2014-07-09 12:57:05 +01003206 }
3207 }
3208 return false;
3209 }
3210
3211 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07003212 * Called by a device owner to set whether auto time is required. If auto time is required the
3213 * user cannot set the date and time, but has to use network date and time.
3214 * <p>
3215 * Note: if auto time is required the user can still manually set the time zone.
3216 * <p>
3217 * The calling device admin must be a device owner. If it is not, a security exception will be
3218 * thrown.
Sander Alewijnse0ced6272014-08-26 11:18:26 +01003219 *
3220 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
3221 * @param required Whether auto time is set required or not.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07003222 * @throws SecurityException if {@code admin} is not a device owner.
Sander Alewijnse0ced6272014-08-26 11:18:26 +01003223 */
Robin Lee25e26452015-06-02 09:56:29 -07003224 public void setAutoTimeRequired(@NonNull ComponentName admin, boolean required) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01003225 throwIfParentInstance("setAutoTimeRequired");
Sander Alewijnse0ced6272014-08-26 11:18:26 +01003226 if (mService != null) {
3227 try {
Fyodor Kupolovbdc58c62015-01-29 13:24:03 -08003228 mService.setAutoTimeRequired(admin, required);
Sander Alewijnse0ced6272014-08-26 11:18:26 +01003229 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07003230 throw e.rethrowFromSystemServer();
Sander Alewijnse0ced6272014-08-26 11:18:26 +01003231 }
3232 }
3233 }
3234
3235 /**
3236 * @return true if auto time is required.
3237 */
3238 public boolean getAutoTimeRequired() {
Benjamin Franzbc33c822016-04-15 08:57:52 +01003239 throwIfParentInstance("getAutoTimeRequired");
Sander Alewijnse0ced6272014-08-26 11:18:26 +01003240 if (mService != null) {
3241 try {
3242 return mService.getAutoTimeRequired();
3243 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07003244 throw e.rethrowFromSystemServer();
Sander Alewijnse0ced6272014-08-26 11:18:26 +01003245 }
3246 }
3247 return false;
3248 }
3249
3250 /**
Lenka Trochtovaf348e8e2016-01-07 17:20:34 +01003251 * Called by a device owner to set whether all users created on the device should be ephemeral.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07003252 * <p>
3253 * The system user is exempt from this policy - it is never ephemeral.
3254 * <p>
3255 * The calling device admin must be the device owner. If it is not, a security exception will be
3256 * thrown.
Lenka Trochtovaf348e8e2016-01-07 17:20:34 +01003257 *
3258 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
3259 * @param forceEphemeralUsers If true, all the existing users will be deleted and all
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07003260 * subsequently created users will be ephemeral.
3261 * @throws SecurityException if {@code admin} is not a device owner.
Lenka Trochtovaf348e8e2016-01-07 17:20:34 +01003262 * @hide
3263 */
3264 public void setForceEphemeralUsers(
3265 @NonNull ComponentName admin, boolean forceEphemeralUsers) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01003266 throwIfParentInstance("setForceEphemeralUsers");
Lenka Trochtovaf348e8e2016-01-07 17:20:34 +01003267 if (mService != null) {
3268 try {
3269 mService.setForceEphemeralUsers(admin, forceEphemeralUsers);
3270 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07003271 throw e.rethrowFromSystemServer();
Lenka Trochtovaf348e8e2016-01-07 17:20:34 +01003272 }
3273 }
3274 }
3275
3276 /**
3277 * @return true if all users are created ephemeral.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07003278 * @throws SecurityException if {@code admin} is not a device owner.
Lenka Trochtovaf348e8e2016-01-07 17:20:34 +01003279 * @hide
3280 */
3281 public boolean getForceEphemeralUsers(@NonNull ComponentName admin) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01003282 throwIfParentInstance("getForceEphemeralUsers");
Lenka Trochtovaf348e8e2016-01-07 17:20:34 +01003283 if (mService != null) {
3284 try {
3285 return mService.getForceEphemeralUsers(admin);
3286 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07003287 throw e.rethrowFromSystemServer();
Lenka Trochtovaf348e8e2016-01-07 17:20:34 +01003288 }
3289 }
3290 return false;
3291 }
3292
3293 /**
Jim Miller48b9b0d2012-09-19 23:16:50 -07003294 * Called by an application that is administering the device to disable keyguard customizations,
3295 * such as widgets. After setting this, keyguard features will be disabled according to the
3296 * provided feature list.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07003297 * <p>
3298 * The calling device admin must have requested
3299 * {@link DeviceAdminInfo#USES_POLICY_DISABLE_KEYGUARD_FEATURES} to be able to call this method;
3300 * if it has not, a security exception will be thrown.
3301 * <p>
3302 * Calling this from a managed profile before version {@link android.os.Build.VERSION_CODES#M}
3303 * will throw a security exception. From version {@link android.os.Build.VERSION_CODES#M} the
3304 * profile owner of a managed profile can set:
Kenny Guy0b7dd1e2015-03-12 17:14:38 +00003305 * <ul>
Esteban Talaverac1c83592016-02-17 17:56:15 +00003306 * <li>{@link #KEYGUARD_DISABLE_TRUST_AGENTS}, which affects the parent user, but only if there
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07003307 * is no separate challenge set on the managed profile.
Esteban Talaverac1c83592016-02-17 17:56:15 +00003308 * <li>{@link #KEYGUARD_DISABLE_FINGERPRINT} which affects the managed profile challenge if
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07003309 * there is one, or the parent user otherwise.
3310 * <li>{@link #KEYGUARD_DISABLE_UNREDACTED_NOTIFICATIONS} which affects notifications generated
3311 * by applications in the managed profile.
Kenny Guy0b7dd1e2015-03-12 17:14:38 +00003312 * </ul>
Esteban Talaverac1c83592016-02-17 17:56:15 +00003313 * {@link #KEYGUARD_DISABLE_TRUST_AGENTS} and {@link #KEYGUARD_DISABLE_FINGERPRINT} can also be
3314 * set on the {@link DevicePolicyManager} instance returned by
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07003315 * {@link #getParentProfileInstance(ComponentName)} in order to set restrictions on the parent
3316 * profile.
3317 * <p>
3318 * Requests to disable other features on a managed profile will be ignored.
3319 * <p>
3320 * The admin can check which features have been disabled by calling
Kenny Guy0b7dd1e2015-03-12 17:14:38 +00003321 * {@link #getKeyguardDisabledFeatures(ComponentName)}
Amith Yamasani242f4b12014-10-14 16:06:13 -07003322 *
Jim Millerb8ec4702012-08-31 17:19:10 -07003323 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
Jim Miller35207742012-11-02 15:33:20 -07003324 * @param which {@link #KEYGUARD_DISABLE_FEATURES_NONE} (default),
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07003325 * {@link #KEYGUARD_DISABLE_WIDGETS_ALL}, {@link #KEYGUARD_DISABLE_SECURE_CAMERA},
3326 * {@link #KEYGUARD_DISABLE_SECURE_NOTIFICATIONS},
3327 * {@link #KEYGUARD_DISABLE_TRUST_AGENTS},
3328 * {@link #KEYGUARD_DISABLE_UNREDACTED_NOTIFICATIONS},
3329 * {@link #KEYGUARD_DISABLE_FINGERPRINT}, {@link #KEYGUARD_DISABLE_FEATURES_ALL}
3330 * @throws SecurityException if {@code admin} is not an active administrator or does not user
3331 * {@link DeviceAdminInfo#USES_POLICY_DISABLE_KEYGUARD_FEATURES}
Jim Millerb8ec4702012-08-31 17:19:10 -07003332 */
Robin Lee25e26452015-06-02 09:56:29 -07003333 public void setKeyguardDisabledFeatures(@NonNull ComponentName admin, int which) {
Jim Millerb8ec4702012-08-31 17:19:10 -07003334 if (mService != null) {
3335 try {
Esteban Talavera62399912016-01-11 15:37:55 +00003336 mService.setKeyguardDisabledFeatures(admin, which, mParentInstance);
Jim Millerb8ec4702012-08-31 17:19:10 -07003337 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07003338 throw e.rethrowFromSystemServer();
Jim Millerb8ec4702012-08-31 17:19:10 -07003339 }
3340 }
3341 }
3342
3343 /**
Makoto Onuki32b30572015-12-11 14:29:51 -08003344 * Determine whether or not features have been disabled in keyguard either by the calling
Esteban Talaverac1c83592016-02-17 17:56:15 +00003345 * admin, if specified, or all admins that set retrictions on this user and its participating
3346 * profiles. Restrictions on profiles that have a separate challenge are not taken into account.
3347 *
3348 * <p>This method can be called on the {@link DevicePolicyManager} instance
3349 * returned by {@link #getParentProfileInstance(ComponentName)} in order to retrieve
3350 * restrictions on the parent profile.
3351 *
Esteban Talavera62399912016-01-11 15:37:55 +00003352 * @param admin The name of the admin component to check, or {@code null} to check whether any
3353 * admins have disabled features in keyguard.
Jim Miller35207742012-11-02 15:33:20 -07003354 * @return bitfield of flags. See {@link #setKeyguardDisabledFeatures(ComponentName, int)}
3355 * for a list.
Jim Millerb8ec4702012-08-31 17:19:10 -07003356 */
Robin Lee25e26452015-06-02 09:56:29 -07003357 public int getKeyguardDisabledFeatures(@Nullable ComponentName admin) {
Makoto Onukicc4bbeb2015-09-17 10:28:24 -07003358 return getKeyguardDisabledFeatures(admin, myUserId());
Amith Yamasani599dd7c2012-09-14 23:20:08 -07003359 }
3360
3361 /** @hide per-user version */
Robin Lee25e26452015-06-02 09:56:29 -07003362 public int getKeyguardDisabledFeatures(@Nullable ComponentName admin, int userHandle) {
Jim Millerb8ec4702012-08-31 17:19:10 -07003363 if (mService != null) {
3364 try {
Esteban Talavera62399912016-01-11 15:37:55 +00003365 return mService.getKeyguardDisabledFeatures(admin, userHandle, mParentInstance);
Jim Millerb8ec4702012-08-31 17:19:10 -07003366 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07003367 throw e.rethrowFromSystemServer();
Jim Millerb8ec4702012-08-31 17:19:10 -07003368 }
3369 }
Jim Miller48b9b0d2012-09-19 23:16:50 -07003370 return KEYGUARD_DISABLE_FEATURES_NONE;
Jim Millerb8ec4702012-08-31 17:19:10 -07003371 }
3372
3373 /**
Dianne Hackbornd6847842010-01-12 18:14:19 -08003374 * @hide
3375 */
Robin Lee25e26452015-06-02 09:56:29 -07003376 public void setActiveAdmin(@NonNull ComponentName policyReceiver, boolean refreshing,
3377 int userHandle) {
Dianne Hackbornd6847842010-01-12 18:14:19 -08003378 if (mService != null) {
3379 try {
Jessica Hummel6d36b602014-04-04 12:42:17 +01003380 mService.setActiveAdmin(policyReceiver, refreshing, userHandle);
Dianne Hackbornd6847842010-01-12 18:14:19 -08003381 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07003382 throw e.rethrowFromSystemServer();
Dianne Hackbornd6847842010-01-12 18:14:19 -08003383 }
3384 }
3385 }
Konstantin Lopyrev32558232010-05-20 16:18:05 -07003386
Dianne Hackbornd6847842010-01-12 18:14:19 -08003387 /**
Jessica Hummel6d36b602014-04-04 12:42:17 +01003388 * @hide
3389 */
Robin Lee25e26452015-06-02 09:56:29 -07003390 public void setActiveAdmin(@NonNull ComponentName policyReceiver, boolean refreshing) {
Makoto Onukicc4bbeb2015-09-17 10:28:24 -07003391 setActiveAdmin(policyReceiver, refreshing, myUserId());
Jessica Hummel6d36b602014-04-04 12:42:17 +01003392 }
3393
3394 /**
Dianne Hackbornd6847842010-01-12 18:14:19 -08003395 * @hide
3396 */
Robin Lee25e26452015-06-02 09:56:29 -07003397 public void getRemoveWarning(@Nullable ComponentName admin, RemoteCallback result) {
Dianne Hackborn8ea138c2010-01-26 18:01:04 -08003398 if (mService != null) {
3399 try {
Makoto Onukicc4bbeb2015-09-17 10:28:24 -07003400 mService.getRemoveWarning(admin, result, myUserId());
Dianne Hackborn8ea138c2010-01-26 18:01:04 -08003401 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07003402 throw e.rethrowFromSystemServer();
Dianne Hackborn8ea138c2010-01-26 18:01:04 -08003403 }
3404 }
3405 }
3406
3407 /**
3408 * @hide
3409 */
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07003410 public void setActivePasswordState(int quality, int length, int letters, int uppercase,
Amith Yamasani599dd7c2012-09-14 23:20:08 -07003411 int lowercase, int numbers, int symbols, int nonletter, int userHandle) {
Dianne Hackbornd6847842010-01-12 18:14:19 -08003412 if (mService != null) {
3413 try {
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07003414 mService.setActivePasswordState(quality, length, letters, uppercase, lowercase,
Amith Yamasani599dd7c2012-09-14 23:20:08 -07003415 numbers, symbols, nonletter, userHandle);
Dianne Hackbornd6847842010-01-12 18:14:19 -08003416 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07003417 throw e.rethrowFromSystemServer();
Dianne Hackbornd6847842010-01-12 18:14:19 -08003418 }
3419 }
3420 }
Konstantin Lopyrev32558232010-05-20 16:18:05 -07003421
Dianne Hackbornd6847842010-01-12 18:14:19 -08003422 /**
3423 * @hide
3424 */
Amith Yamasani599dd7c2012-09-14 23:20:08 -07003425 public void reportFailedPasswordAttempt(int userHandle) {
Dianne Hackbornd6847842010-01-12 18:14:19 -08003426 if (mService != null) {
3427 try {
Amith Yamasani599dd7c2012-09-14 23:20:08 -07003428 mService.reportFailedPasswordAttempt(userHandle);
Dianne Hackbornd6847842010-01-12 18:14:19 -08003429 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07003430 throw e.rethrowFromSystemServer();
Dianne Hackbornd6847842010-01-12 18:14:19 -08003431 }
3432 }
3433 }
Konstantin Lopyrev32558232010-05-20 16:18:05 -07003434
Dianne Hackbornd6847842010-01-12 18:14:19 -08003435 /**
3436 * @hide
3437 */
Amith Yamasani599dd7c2012-09-14 23:20:08 -07003438 public void reportSuccessfulPasswordAttempt(int userHandle) {
Dianne Hackbornd6847842010-01-12 18:14:19 -08003439 if (mService != null) {
3440 try {
Amith Yamasani599dd7c2012-09-14 23:20:08 -07003441 mService.reportSuccessfulPasswordAttempt(userHandle);
Dianne Hackbornd6847842010-01-12 18:14:19 -08003442 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07003443 throw e.rethrowFromSystemServer();
Dianne Hackbornd6847842010-01-12 18:14:19 -08003444 }
3445 }
3446 }
Amith Yamasani71e6c692013-03-24 17:39:28 -07003447
3448 /**
Michal Karpinskied5c8f02016-02-09 15:43:41 +00003449 * @hide
3450 */
3451 public void reportFailedFingerprintAttempt(int userHandle) {
3452 if (mService != null) {
3453 try {
3454 mService.reportFailedFingerprintAttempt(userHandle);
3455 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07003456 throw e.rethrowFromSystemServer();
Michal Karpinskied5c8f02016-02-09 15:43:41 +00003457 }
3458 }
3459 }
3460
3461 /**
3462 * @hide
3463 */
3464 public void reportSuccessfulFingerprintAttempt(int userHandle) {
3465 if (mService != null) {
3466 try {
3467 mService.reportSuccessfulFingerprintAttempt(userHandle);
3468 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07003469 throw e.rethrowFromSystemServer();
Michal Karpinskied5c8f02016-02-09 15:43:41 +00003470 }
3471 }
3472 }
3473
3474 /**
Michal Karpinski31502d32016-01-25 16:43:07 +00003475 * Should be called when keyguard has been dismissed.
3476 * @hide
3477 */
Michal Karpinskied5c8f02016-02-09 15:43:41 +00003478 public void reportKeyguardDismissed(int userHandle) {
Michal Karpinski31502d32016-01-25 16:43:07 +00003479 if (mService != null) {
3480 try {
Michal Karpinskied5c8f02016-02-09 15:43:41 +00003481 mService.reportKeyguardDismissed(userHandle);
Michal Karpinski31502d32016-01-25 16:43:07 +00003482 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07003483 throw e.rethrowFromSystemServer();
Michal Karpinski31502d32016-01-25 16:43:07 +00003484 }
3485 }
3486 }
3487
3488 /**
3489 * Should be called when keyguard view has been shown to the user.
3490 * @hide
3491 */
Michal Karpinskied5c8f02016-02-09 15:43:41 +00003492 public void reportKeyguardSecured(int userHandle) {
Michal Karpinski31502d32016-01-25 16:43:07 +00003493 if (mService != null) {
3494 try {
Michal Karpinskied5c8f02016-02-09 15:43:41 +00003495 mService.reportKeyguardSecured(userHandle);
Michal Karpinski31502d32016-01-25 16:43:07 +00003496 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07003497 throw e.rethrowFromSystemServer();
Michal Karpinski31502d32016-01-25 16:43:07 +00003498 }
3499 }
3500 }
3501
3502 /**
Amith Yamasani71e6c692013-03-24 17:39:28 -07003503 * @hide
Nicolas Prevot28063742015-01-08 15:37:12 +00003504 * Sets the given package as the device owner.
Makoto Onukia52562c2015-10-01 16:12:31 -07003505 * Same as {@link #setDeviceOwner(ComponentName, String)} but without setting a device owner name.
3506 * @param who the component name to be registered as device owner.
Amith Yamasani71e6c692013-03-24 17:39:28 -07003507 * @return whether the package was successfully registered as the device owner.
3508 * @throws IllegalArgumentException if the package name is null or invalid
Nicolas Prevot28063742015-01-08 15:37:12 +00003509 * @throws IllegalStateException If the preconditions mentioned are not met.
Amith Yamasani71e6c692013-03-24 17:39:28 -07003510 */
Makoto Onukia52562c2015-10-01 16:12:31 -07003511 public boolean setDeviceOwner(ComponentName who) {
3512 return setDeviceOwner(who, null);
Geoffrey Borggaard334c7e32013-08-08 14:31:36 -04003513 }
3514
3515 /**
3516 * @hide
Makoto Onuki58b684f2015-09-04 10:48:16 -07003517 */
Makoto Onukia52562c2015-10-01 16:12:31 -07003518 public boolean setDeviceOwner(ComponentName who, int userId) {
3519 return setDeviceOwner(who, null, userId);
Makoto Onuki58b684f2015-09-04 10:48:16 -07003520 }
3521
3522 /**
3523 * @hide
3524 */
Makoto Onukia52562c2015-10-01 16:12:31 -07003525 public boolean setDeviceOwner(ComponentName who, String ownerName) {
3526 return setDeviceOwner(who, ownerName, UserHandle.USER_SYSTEM);
Makoto Onuki58b684f2015-09-04 10:48:16 -07003527 }
3528
3529 /**
3530 * @hide
Nicolas Prevot28063742015-01-08 15:37:12 +00003531 * Sets the given package as the device owner. The package must already be installed. There
3532 * must not already be a device owner.
3533 * Only apps with the MANAGE_PROFILE_AND_DEVICE_OWNERS permission and the shell uid can call
3534 * this method.
3535 * Calling this after the setup phase of the primary user has completed is allowed only if
3536 * the caller is the shell uid, and there are no additional users and no accounts.
Makoto Onukia52562c2015-10-01 16:12:31 -07003537 * @param who the component name to be registered as device owner.
Geoffrey Borggaard334c7e32013-08-08 14:31:36 -04003538 * @param ownerName the human readable name of the institution that owns this device.
Makoto Onuki58b684f2015-09-04 10:48:16 -07003539 * @param userId ID of the user on which the device owner runs.
Geoffrey Borggaard334c7e32013-08-08 14:31:36 -04003540 * @return whether the package was successfully registered as the device owner.
3541 * @throws IllegalArgumentException if the package name is null or invalid
Nicolas Prevot28063742015-01-08 15:37:12 +00003542 * @throws IllegalStateException If the preconditions mentioned are not met.
Geoffrey Borggaard334c7e32013-08-08 14:31:36 -04003543 */
Makoto Onukia52562c2015-10-01 16:12:31 -07003544 public boolean setDeviceOwner(ComponentName who, String ownerName, int userId)
Geoffrey Borggaard334c7e32013-08-08 14:31:36 -04003545 throws IllegalArgumentException, IllegalStateException {
Amith Yamasani71e6c692013-03-24 17:39:28 -07003546 if (mService != null) {
3547 try {
Makoto Onukia52562c2015-10-01 16:12:31 -07003548 return mService.setDeviceOwner(who, ownerName, userId);
Amith Yamasani71e6c692013-03-24 17:39:28 -07003549 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07003550 throw re.rethrowFromSystemServer();
Amith Yamasani71e6c692013-03-24 17:39:28 -07003551 }
3552 }
3553 return false;
3554 }
3555
3556 /**
Amith Yamasani3b458ad2013-04-18 18:40:07 -07003557 * Used to determine if a particular package has been registered as a Device Owner app.
3558 * A device owner app is a special device admin that cannot be deactivated by the user, once
Robin Lee25e26452015-06-02 09:56:29 -07003559 * activated as a device admin. It also cannot be uninstalled. To check whether a particular
Amith Yamasani3b458ad2013-04-18 18:40:07 -07003560 * package is currently registered as the device owner app, pass in the package name from
3561 * {@link Context#getPackageName()} to this method.<p/>This is useful for device
Robin Lee25e26452015-06-02 09:56:29 -07003562 * admin apps that want to check whether they are also registered as the device owner app. The
Amith Yamasani3b458ad2013-04-18 18:40:07 -07003563 * exact mechanism by which a device admin app is registered as a device owner app is defined by
3564 * the setup process.
3565 * @param packageName the package name of the app, to compare with the registered device owner
3566 * app, if any.
Makoto Onukic8a5a552015-11-19 14:29:12 -08003567 * @return whether or not the package is registered as the device owner app.
Amith Yamasani71e6c692013-03-24 17:39:28 -07003568 */
Amith Yamasani3b458ad2013-04-18 18:40:07 -07003569 public boolean isDeviceOwnerApp(String packageName) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01003570 throwIfParentInstance("isDeviceOwnerApp");
Makoto Onukic8a5a552015-11-19 14:29:12 -08003571 return isDeviceOwnerAppOnCallingUser(packageName);
3572 }
3573
3574 /**
3575 * @return true if a package is registered as device owner, only when it's running on the
3576 * calling user.
3577 *
3578 * <p>Same as {@link #isDeviceOwnerApp}, but bundled code should use it for clarity.
3579 * @hide
3580 */
3581 public boolean isDeviceOwnerAppOnCallingUser(String packageName) {
3582 return isDeviceOwnerAppOnAnyUserInner(packageName, /* callingUserOnly =*/ true);
3583 }
3584
3585 /**
3586 * @return true if a package is registered as device owner, even if it's running on a different
3587 * user.
3588 *
3589 * <p>Requires the MANAGE_USERS permission.
3590 *
3591 * @hide
3592 */
3593 public boolean isDeviceOwnerAppOnAnyUser(String packageName) {
3594 return isDeviceOwnerAppOnAnyUserInner(packageName, /* callingUserOnly =*/ false);
3595 }
3596
3597 /**
3598 * @return device owner component name, only when it's running on the calling user.
3599 *
3600 * @hide
3601 */
3602 public ComponentName getDeviceOwnerComponentOnCallingUser() {
3603 return getDeviceOwnerComponentInner(/* callingUserOnly =*/ true);
3604 }
3605
3606 /**
3607 * @return device owner component name, even if it's running on a different user.
3608 *
3609 * <p>Requires the MANAGE_USERS permission.
3610 *
3611 * @hide
3612 */
3613 public ComponentName getDeviceOwnerComponentOnAnyUser() {
3614 return getDeviceOwnerComponentInner(/* callingUserOnly =*/ false);
3615 }
3616
3617 private boolean isDeviceOwnerAppOnAnyUserInner(String packageName, boolean callingUserOnly) {
Makoto Onuki70f929e2015-11-11 12:40:15 -08003618 if (packageName == null) {
3619 return false;
Amith Yamasani71e6c692013-03-24 17:39:28 -07003620 }
Makoto Onukic8a5a552015-11-19 14:29:12 -08003621 final ComponentName deviceOwner = getDeviceOwnerComponentInner(callingUserOnly);
Makoto Onuki70f929e2015-11-11 12:40:15 -08003622 if (deviceOwner == null) {
3623 return false;
3624 }
3625 return packageName.equals(deviceOwner.getPackageName());
Amith Yamasani71e6c692013-03-24 17:39:28 -07003626 }
3627
Makoto Onukic8a5a552015-11-19 14:29:12 -08003628 private ComponentName getDeviceOwnerComponentInner(boolean callingUserOnly) {
3629 if (mService != null) {
3630 try {
3631 return mService.getDeviceOwnerComponent(callingUserOnly);
3632 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07003633 throw re.rethrowFromSystemServer();
Makoto Onukic8a5a552015-11-19 14:29:12 -08003634 }
3635 }
3636 return null;
Amith Yamasani3b458ad2013-04-18 18:40:07 -07003637 }
3638
Jason Monkb0dced82014-06-06 14:36:20 -04003639 /**
Makoto Onukic8a5a552015-11-19 14:29:12 -08003640 * @return ID of the user who runs device owner, or {@link UserHandle#USER_NULL} if there's
3641 * no device owner.
3642 *
3643 * <p>Requires the MANAGE_USERS permission.
Makoto Onukia52562c2015-10-01 16:12:31 -07003644 *
3645 * @hide
3646 */
Makoto Onukic8a5a552015-11-19 14:29:12 -08003647 public int getDeviceOwnerUserId() {
3648 if (mService != null) {
3649 try {
3650 return mService.getDeviceOwnerUserId();
3651 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07003652 throw re.rethrowFromSystemServer();
Makoto Onukic8a5a552015-11-19 14:29:12 -08003653 }
3654 }
3655 return UserHandle.USER_NULL;
Makoto Onukia52562c2015-10-01 16:12:31 -07003656 }
3657
3658 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07003659 * Clears the current device owner. The caller must be the device owner. This function should be
3660 * used cautiously as once it is called it cannot be undone. The device owner can only be set as
3661 * a part of device setup before setup completes.
Jason Monk94d2cf92014-06-18 09:53:34 -04003662 *
3663 * @param packageName The package name of the device owner.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07003664 * @throws SecurityException if the caller is not in {@code packageName} or {@code packageName}
3665 * does not own the current device owner component.
Jason Monkb0dced82014-06-06 14:36:20 -04003666 */
Jason Monk94d2cf92014-06-18 09:53:34 -04003667 public void clearDeviceOwnerApp(String packageName) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01003668 throwIfParentInstance("clearDeviceOwnerApp");
Jason Monkb0dced82014-06-06 14:36:20 -04003669 if (mService != null) {
3670 try {
Jason Monk94d2cf92014-06-18 09:53:34 -04003671 mService.clearDeviceOwner(packageName);
Jason Monkb0dced82014-06-06 14:36:20 -04003672 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07003673 throw re.rethrowFromSystemServer();
Jason Monkb0dced82014-06-06 14:36:20 -04003674 }
3675 }
3676 }
3677
Makoto Onukia52562c2015-10-01 16:12:31 -07003678 /**
Makoto Onukic8a5a552015-11-19 14:29:12 -08003679 * Returns the device owner package name, only if it's running on the calling user.
3680 *
3681 * <p>Bundled components should use {@code getDeviceOwnerComponentOnCallingUser()} for clarity.
Makoto Onukia52562c2015-10-01 16:12:31 -07003682 *
3683 * @hide
3684 */
Nicolas Prevot465acf32014-08-06 17:03:25 +01003685 @SystemApi
Amith Yamasani71e6c692013-03-24 17:39:28 -07003686 public String getDeviceOwner() {
Benjamin Franzbc33c822016-04-15 08:57:52 +01003687 throwIfParentInstance("getDeviceOwner");
Makoto Onukic8a5a552015-11-19 14:29:12 -08003688 final ComponentName name = getDeviceOwnerComponentOnCallingUser();
3689 return name != null ? name.getPackageName() : null;
Makoto Onukia52562c2015-10-01 16:12:31 -07003690 }
3691
3692 /**
Makoto Onukic8a5a552015-11-19 14:29:12 -08003693 * @return true if the device is managed by any device owner.
3694 *
3695 * <p>Requires the MANAGE_USERS permission.
Makoto Onukia52562c2015-10-01 16:12:31 -07003696 *
3697 * @hide
3698 */
Makoto Onukic8a5a552015-11-19 14:29:12 -08003699 public boolean isDeviceManaged() {
3700 return getDeviceOwnerComponentOnAnyUser() != null;
3701 }
3702
3703 /**
3704 * Returns the device owner name. Note this method *will* return the device owner
3705 * name when it's running on a different user.
3706 *
3707 * <p>Requires the MANAGE_USERS permission.
3708 *
3709 * @hide
3710 */
Makoto Onukia2b274b2016-01-19 13:26:02 -08003711 @SystemApi
Makoto Onukic8a5a552015-11-19 14:29:12 -08003712 public String getDeviceOwnerNameOnAnyUser() {
Benjamin Franzbc33c822016-04-15 08:57:52 +01003713 throwIfParentInstance("getDeviceOwnerNameOnAnyUser");
Amith Yamasani71e6c692013-03-24 17:39:28 -07003714 if (mService != null) {
3715 try {
Makoto Onukia52562c2015-10-01 16:12:31 -07003716 return mService.getDeviceOwnerName();
Amith Yamasani71e6c692013-03-24 17:39:28 -07003717 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07003718 throw re.rethrowFromSystemServer();
Geoffrey Borggaard334c7e32013-08-08 14:31:36 -04003719 }
3720 }
3721 return null;
3722 }
Adam Connors776c5552014-01-09 10:42:56 +00003723
3724 /**
Julia Reynolds94e7bf62015-06-10 14:44:56 -04003725 * @hide
Craig Lafayettee7ee54e2015-09-21 13:48:53 -04003726 * @deprecated Do not use
3727 * @removed
Julia Reynolds20118f12015-02-11 12:34:08 -05003728 */
Craig Lafayettee7ee54e2015-09-21 13:48:53 -04003729 @Deprecated
Julia Reynolds20118f12015-02-11 12:34:08 -05003730 @SystemApi
3731 public String getDeviceInitializerApp() {
Julia Reynolds20118f12015-02-11 12:34:08 -05003732 return null;
3733 }
3734
3735 /**
Julia Reynoldseaafdf722015-04-02 08:49:47 -04003736 * @hide
Craig Lafayettee7ee54e2015-09-21 13:48:53 -04003737 * @deprecated Do not use
3738 * @removed
Julia Reynoldseaafdf722015-04-02 08:49:47 -04003739 */
Craig Lafayettee7ee54e2015-09-21 13:48:53 -04003740 @Deprecated
Julia Reynoldseaafdf722015-04-02 08:49:47 -04003741 @SystemApi
3742 public ComponentName getDeviceInitializerComponent() {
Julia Reynoldseaafdf722015-04-02 08:49:47 -04003743 return null;
3744 }
3745
Julia Reynolds20118f12015-02-11 12:34:08 -05003746 /**
Adam Connors776c5552014-01-09 10:42:56 +00003747 * @hide
Amith Yamasanibf3a9462014-07-28 14:26:42 -07003748 * @deprecated Use #ACTION_SET_PROFILE_OWNER
Amith Yamasaniaba4f1b2014-07-01 15:36:12 +05303749 * Sets the given component as an active admin and registers the package as the profile
3750 * owner for this user. The package must already be installed and there shouldn't be
3751 * an existing profile owner registered for this user. Also, this method must be called
3752 * before the user setup has been completed.
3753 * <p>
3754 * This method can only be called by system apps that hold MANAGE_USERS permission and
3755 * MANAGE_DEVICE_ADMINS permission.
3756 * @param admin The component to register as an active admin and profile owner.
3757 * @param ownerName The user-visible name of the entity that is managing this user.
3758 * @return whether the admin was successfully registered as the profile owner.
3759 * @throws IllegalArgumentException if packageName is null, the package isn't installed, or
3760 * the user has already been set up.
3761 */
Aurimas Liutikas514c5ef2016-05-24 15:22:55 -07003762 @Deprecated
Justin Morey80440cc2014-07-24 09:16:35 -05003763 @SystemApi
Robin Lee25e26452015-06-02 09:56:29 -07003764 public boolean setActiveProfileOwner(@NonNull ComponentName admin, @Deprecated String ownerName)
Amith Yamasaniaba4f1b2014-07-01 15:36:12 +05303765 throws IllegalArgumentException {
Benjamin Franzbc33c822016-04-15 08:57:52 +01003766 throwIfParentInstance("setActiveProfileOwner");
Amith Yamasaniaba4f1b2014-07-01 15:36:12 +05303767 if (mService != null) {
3768 try {
Makoto Onukicc4bbeb2015-09-17 10:28:24 -07003769 final int myUserId = myUserId();
Amith Yamasaniaba4f1b2014-07-01 15:36:12 +05303770 mService.setActiveAdmin(admin, false, myUserId);
Amith Yamasanibf3a9462014-07-28 14:26:42 -07003771 return mService.setProfileOwner(admin, ownerName, myUserId);
Amith Yamasaniaba4f1b2014-07-01 15:36:12 +05303772 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07003773 throw re.rethrowFromSystemServer();
Amith Yamasaniaba4f1b2014-07-01 15:36:12 +05303774 }
3775 }
3776 return false;
3777 }
3778
3779 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07003780 * Clears the active profile owner and removes all user restrictions. The caller must be from
3781 * the same package as the active profile owner for this user, otherwise a SecurityException
3782 * will be thrown.
3783 * <p>
3784 * This doesn't work for managed profile owners.
Makoto Onuki5bf68022016-01-27 13:49:19 -08003785 *
Amith Yamasanibf3a9462014-07-28 14:26:42 -07003786 * @param admin The component to remove as the profile owner.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07003787 * @throws SecurityException if {@code admin} is not an active profile owner.
Amith Yamasanibf3a9462014-07-28 14:26:42 -07003788 */
Robin Lee25e26452015-06-02 09:56:29 -07003789 public void clearProfileOwner(@NonNull ComponentName admin) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01003790 throwIfParentInstance("clearProfileOwner");
Amith Yamasanibf3a9462014-07-28 14:26:42 -07003791 if (mService != null) {
3792 try {
3793 mService.clearProfileOwner(admin);
3794 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07003795 throw re.rethrowFromSystemServer();
Amith Yamasanibf3a9462014-07-28 14:26:42 -07003796 }
3797 }
3798 }
3799
3800 /**
Julia Reynoldse9254402015-02-11 12:34:08 -05003801 * @hide
Robin Lee25e26452015-06-02 09:56:29 -07003802 * Checks whether the user was already setup.
Amith Yamasanibf3a9462014-07-28 14:26:42 -07003803 */
3804 public boolean hasUserSetupCompleted() {
3805 if (mService != null) {
3806 try {
3807 return mService.hasUserSetupCompleted();
3808 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07003809 throw re.rethrowFromSystemServer();
Amith Yamasanibf3a9462014-07-28 14:26:42 -07003810 }
3811 }
3812 return true;
3813 }
3814
3815 /**
Amith Yamasanibf3a9462014-07-28 14:26:42 -07003816 * @hide
3817 * Sets the given component as the profile owner of the given user profile. The package must
Nicolas Prevot28063742015-01-08 15:37:12 +00003818 * already be installed. There must not already be a profile owner for this user.
3819 * Only apps with the MANAGE_PROFILE_AND_DEVICE_OWNERS permission and the shell uid can call
3820 * this method.
3821 * Calling this after the setup phase of the specified user has completed is allowed only if:
3822 * - the caller is SYSTEM_UID.
3823 * - or the caller is the shell uid, and there are no accounts on the specified user.
Amith Yamasanibf3a9462014-07-28 14:26:42 -07003824 * @param admin the component name to be registered as profile owner.
3825 * @param ownerName the human readable name of the organisation associated with this DPM.
3826 * @param userHandle the userId to set the profile owner for.
3827 * @return whether the component was successfully registered as the profile owner.
Nicolas Prevot28063742015-01-08 15:37:12 +00003828 * @throws IllegalArgumentException if admin is null, the package isn't installed, or the
3829 * preconditions mentioned are not met.
Amith Yamasanibf3a9462014-07-28 14:26:42 -07003830 */
Robin Lee25e26452015-06-02 09:56:29 -07003831 public boolean setProfileOwner(@NonNull ComponentName admin, @Deprecated String ownerName,
Robin Leeddd553f2015-04-30 14:18:22 +01003832 int userHandle) throws IllegalArgumentException {
Adam Connors776c5552014-01-09 10:42:56 +00003833 if (mService != null) {
3834 try {
Amith Yamasanibf3a9462014-07-28 14:26:42 -07003835 if (ownerName == null) {
3836 ownerName = "";
3837 }
3838 return mService.setProfileOwner(admin, ownerName, userHandle);
Adam Connors776c5552014-01-09 10:42:56 +00003839 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07003840 throw re.rethrowFromSystemServer();
Adam Connors776c5552014-01-09 10:42:56 +00003841 }
3842 }
3843 return false;
3844 }
3845
3846 /**
Andrei Stingaceanu6644cd92015-11-10 13:03:31 +00003847 * Sets the device owner information to be shown on the lock screen.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07003848 * <p>
3849 * If the device owner information is {@code null} or empty then the device owner info is
Andrei Stingaceanu6644cd92015-11-10 13:03:31 +00003850 * cleared and the user owner info is shown on the lock screen if it is set.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07003851 * <p>
3852 * If the device owner information contains only whitespaces then the message on the lock screen
3853 * will be blank and the user will not be allowed to change it.
3854 * <p>
3855 * If the device owner information needs to be localized, it is the responsibility of the
Benjamin Franz3e8a7092016-01-25 16:19:08 +00003856 * {@link DeviceAdminReceiver} to listen to the {@link Intent#ACTION_LOCALE_CHANGED} broadcast
3857 * and set a new version of this string accordingly.
3858 *
Andrei Stingaceanu6644cd92015-11-10 13:03:31 +00003859 * @param admin The name of the admin component to check.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07003860 * @param info Device owner information which will be displayed instead of the user owner info.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07003861 * @throws SecurityException if {@code admin} is not a device owner.
Andrei Stingaceanu6644cd92015-11-10 13:03:31 +00003862 */
Andrei Stingaceanu16187902016-03-21 15:44:45 +00003863 public void setDeviceOwnerLockScreenInfo(@NonNull ComponentName admin, CharSequence info) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01003864 throwIfParentInstance("setDeviceOwnerLockScreenInfo");
Andrei Stingaceanu6644cd92015-11-10 13:03:31 +00003865 if (mService != null) {
3866 try {
Andrei Stingaceanu16187902016-03-21 15:44:45 +00003867 mService.setDeviceOwnerLockScreenInfo(admin, info);
Andrei Stingaceanu6644cd92015-11-10 13:03:31 +00003868 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07003869 throw re.rethrowFromSystemServer();
Andrei Stingaceanu6644cd92015-11-10 13:03:31 +00003870 }
3871 }
Andrei Stingaceanu6644cd92015-11-10 13:03:31 +00003872 }
3873
3874 /**
3875 * @return The device owner information. If it is not set returns {@code null}.
3876 */
Andrei Stingaceanu16187902016-03-21 15:44:45 +00003877 public CharSequence getDeviceOwnerLockScreenInfo() {
Benjamin Franzbc33c822016-04-15 08:57:52 +01003878 throwIfParentInstance("getDeviceOwnerLockScreenInfo");
Andrei Stingaceanu6644cd92015-11-10 13:03:31 +00003879 if (mService != null) {
3880 try {
3881 return mService.getDeviceOwnerLockScreenInfo();
3882 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07003883 throw re.rethrowFromSystemServer();
Andrei Stingaceanu6644cd92015-11-10 13:03:31 +00003884 }
3885 }
3886 return null;
3887 }
3888
3889 /**
Andrei Stingaceanueb84b182016-01-26 18:39:55 +00003890 * Called by device or profile owners to suspend packages for this user.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07003891 * <p>
3892 * A suspended package will not be able to start activities. Its notifications will be hidden,
3893 * it will not show up in recents, will not be able to show toasts or dialogs or ring the
3894 * device.
3895 * <p>
3896 * The package must already be installed. If the package is uninstalled while suspended the
3897 * package will no longer be suspended. The admin can block this by using
Kenny Guy871f3eb2016-03-09 20:06:16 +00003898 * {@link #setUninstallBlocked}.
Andrei Stingaceanu1e283912015-11-26 15:26:28 +00003899 *
3900 * @param admin The name of the admin component to check.
Andrei Stingaceanueb84b182016-01-26 18:39:55 +00003901 * @param packageNames The package names to suspend or unsuspend.
3902 * @param suspended If set to {@code true} than the packages will be suspended, if set to
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07003903 * {@code false} the packages will be unsuspended.
Andrei Stingaceanueb84b182016-01-26 18:39:55 +00003904 * @return an array of package names for which the suspended status is not set as requested in
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07003905 * this method.
3906 * @throws SecurityException if {@code admin} is not a device or profile owner.
Andrei Stingaceanu1e283912015-11-26 15:26:28 +00003907 */
Andrei Stingaceanueb84b182016-01-26 18:39:55 +00003908 public String[] setPackagesSuspended(@NonNull ComponentName admin, String[] packageNames,
Andrei Stingaceanu1e283912015-11-26 15:26:28 +00003909 boolean suspended) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01003910 throwIfParentInstance("setPackagesSuspended");
Andrei Stingaceanu1e283912015-11-26 15:26:28 +00003911 if (mService != null) {
3912 try {
Andrei Stingaceanueb84b182016-01-26 18:39:55 +00003913 return mService.setPackagesSuspended(admin, packageNames, suspended);
Andrei Stingaceanu1e283912015-11-26 15:26:28 +00003914 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07003915 throw re.rethrowFromSystemServer();
Andrei Stingaceanu1e283912015-11-26 15:26:28 +00003916 }
3917 }
Andrei Stingaceanueb84b182016-01-26 18:39:55 +00003918 return packageNames;
Andrei Stingaceanu1e283912015-11-26 15:26:28 +00003919 }
3920
3921 /**
3922 * Called by device or profile owners to determine if a package is suspended.
3923 *
3924 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
3925 * @param packageName The name of the package to retrieve the suspended status of.
Andrei Stingaceanu355b2322016-02-12 16:43:51 +00003926 * @return {@code true} if the package is suspended or {@code false} if the package is not
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07003927 * suspended, could not be found or an error occurred.
3928 * @throws SecurityException if {@code admin} is not a device or profile owner.
Andrei Stingaceanuefc4a342016-03-22 14:43:01 +00003929 * @throws NameNotFoundException if the package could not be found.
Andrei Stingaceanu1e283912015-11-26 15:26:28 +00003930 */
Andrei Stingaceanuefc4a342016-03-22 14:43:01 +00003931 public boolean isPackageSuspended(@NonNull ComponentName admin, String packageName)
3932 throws NameNotFoundException {
Benjamin Franzbc33c822016-04-15 08:57:52 +01003933 throwIfParentInstance("isPackageSuspended");
Andrei Stingaceanu1e283912015-11-26 15:26:28 +00003934 if (mService != null) {
3935 try {
Andrei Stingaceanuefc4a342016-03-22 14:43:01 +00003936 return mService.isPackageSuspended(admin, packageName);
Andrei Stingaceanu1e283912015-11-26 15:26:28 +00003937 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07003938 throw e.rethrowFromSystemServer();
Andrei Stingaceanuefc4a342016-03-22 14:43:01 +00003939 } catch (IllegalArgumentException ex) {
3940 throw new NameNotFoundException(packageName);
Andrei Stingaceanu1e283912015-11-26 15:26:28 +00003941 }
3942 }
3943 return false;
3944 }
3945
3946 /**
Alexandra Gherghina512675b2014-04-02 11:23:54 +01003947 * Sets the enabled state of the profile. A profile should be enabled only once it is ready to
3948 * be used. Only the profile owner can call this.
3949 *
Alexandra Gherghinadf35d572014-04-09 13:54:39 +01003950 * @see #isProfileOwnerApp
Alexandra Gherghina512675b2014-04-02 11:23:54 +01003951 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07003952 * @throws SecurityException if {@code admin} is not a profile owner.
Alexandra Gherghina512675b2014-04-02 11:23:54 +01003953 */
Robin Lee25e26452015-06-02 09:56:29 -07003954 public void setProfileEnabled(@NonNull ComponentName admin) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01003955 throwIfParentInstance("setProfileEnabled");
Alexandra Gherghina512675b2014-04-02 11:23:54 +01003956 if (mService != null) {
3957 try {
3958 mService.setProfileEnabled(admin);
3959 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07003960 throw e.rethrowFromSystemServer();
Alexandra Gherghina512675b2014-04-02 11:23:54 +01003961 }
3962 }
3963 }
3964
3965 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07003966 * Sets the name of the profile. In the device owner case it sets the name of the user which it
3967 * is called from. Only a profile owner or device owner can call this. If this is never called
3968 * by the profile or device owner, the name will be set to default values.
Jessica Hummel1333ea12014-06-23 11:20:10 +01003969 *
3970 * @see #isProfileOwnerApp
3971 * @see #isDeviceOwnerApp
Robin Lee25e26452015-06-02 09:56:29 -07003972 * @param admin Which {@link DeviceAdminReceiver} this request is associate with.
Jessica Hummel1333ea12014-06-23 11:20:10 +01003973 * @param profileName The name of the profile.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07003974 * @throws SecurityException if {@code admin} is not a device or profile owner.
Jessica Hummel1333ea12014-06-23 11:20:10 +01003975 */
Robin Lee25e26452015-06-02 09:56:29 -07003976 public void setProfileName(@NonNull ComponentName admin, String profileName) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01003977 throwIfParentInstance("setProfileName");
Jessica Hummel1333ea12014-06-23 11:20:10 +01003978 if (mService != null) {
3979 try {
Robin Lee25e26452015-06-02 09:56:29 -07003980 mService.setProfileName(admin, profileName);
Fyodor Kupolov78f13142015-05-27 16:52:45 -07003981 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07003982 throw e.rethrowFromSystemServer();
Fyodor Kupolov78f13142015-05-27 16:52:45 -07003983 }
Jessica Hummel1333ea12014-06-23 11:20:10 +01003984 }
3985 }
Jessica Hummel1333ea12014-06-23 11:20:10 +01003986
3987 /**
Amith Yamasanic34dc7c2014-09-18 09:42:42 -07003988 * Used to determine if a particular package is registered as the profile owner for the
Makoto Onuki32b30572015-12-11 14:29:51 -08003989 * user. A profile owner is a special device admin that has additional privileges
Amith Yamasanic34dc7c2014-09-18 09:42:42 -07003990 * within the profile.
Adam Connors776c5552014-01-09 10:42:56 +00003991 *
3992 * @param packageName The package name of the app to compare with the registered profile owner.
3993 * @return Whether or not the package is registered as the profile owner.
3994 */
3995 public boolean isProfileOwnerApp(String packageName) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01003996 throwIfParentInstance("isProfileOwnerApp");
Adam Connors776c5552014-01-09 10:42:56 +00003997 if (mService != null) {
3998 try {
Makoto Onuki90b89652016-01-28 14:44:18 -08003999 ComponentName profileOwner = mService.getProfileOwner(myUserId());
Nicolas Prevot90af6d72014-07-30 14:19:12 +01004000 return profileOwner != null
4001 && profileOwner.getPackageName().equals(packageName);
Adam Connors776c5552014-01-09 10:42:56 +00004002 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07004003 throw re.rethrowFromSystemServer();
Adam Connors776c5552014-01-09 10:42:56 +00004004 }
4005 }
4006 return false;
4007 }
4008
4009 /**
4010 * @hide
Robin Lee25e26452015-06-02 09:56:29 -07004011 * @return the packageName of the owner of the given user profile or {@code null} if no profile
Adam Connors776c5552014-01-09 10:42:56 +00004012 * owner has been set for that user.
4013 * @throws IllegalArgumentException if the userId is invalid.
4014 */
Nicolas Prevot465acf32014-08-06 17:03:25 +01004015 @SystemApi
Amith Yamasanibf3a9462014-07-28 14:26:42 -07004016 public ComponentName getProfileOwner() throws IllegalArgumentException {
Benjamin Franzbc33c822016-04-15 08:57:52 +01004017 throwIfParentInstance("getProfileOwner");
Zoltan Szatmary-Ban3f1ddf82014-07-02 16:42:05 +01004018 return getProfileOwnerAsUser(Process.myUserHandle().getIdentifier());
4019 }
4020
4021 /**
4022 * @see #getProfileOwner()
4023 * @hide
4024 */
4025 public ComponentName getProfileOwnerAsUser(final int userId) throws IllegalArgumentException {
Adam Connors776c5552014-01-09 10:42:56 +00004026 if (mService != null) {
4027 try {
Zoltan Szatmary-Ban3f1ddf82014-07-02 16:42:05 +01004028 return mService.getProfileOwner(userId);
Adam Connors776c5552014-01-09 10:42:56 +00004029 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07004030 throw re.rethrowFromSystemServer();
Adam Connors776c5552014-01-09 10:42:56 +00004031 }
4032 }
4033 return null;
4034 }
4035
4036 /**
4037 * @hide
Robin Lee25e26452015-06-02 09:56:29 -07004038 * @return the human readable name of the organisation associated with this DPM or {@code null}
4039 * if one is not set.
Adam Connors776c5552014-01-09 10:42:56 +00004040 * @throws IllegalArgumentException if the userId is invalid.
4041 */
4042 public String getProfileOwnerName() throws IllegalArgumentException {
4043 if (mService != null) {
4044 try {
4045 return mService.getProfileOwnerName(Process.myUserHandle().getIdentifier());
4046 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07004047 throw re.rethrowFromSystemServer();
Adam Connors776c5552014-01-09 10:42:56 +00004048 }
4049 }
4050 return null;
4051 }
Sander Alewijnsef475ca32014-02-17 15:13:58 +00004052
4053 /**
Amith Yamasani38f836b2014-08-20 14:51:15 -07004054 * @hide
Makoto Onukic8a5a552015-11-19 14:29:12 -08004055 * @param userId The user for whom to fetch the profile owner name, if any.
Amith Yamasani38f836b2014-08-20 14:51:15 -07004056 * @return the human readable name of the organisation associated with this profile owner or
4057 * null if one is not set.
4058 * @throws IllegalArgumentException if the userId is invalid.
4059 */
4060 @SystemApi
Selim Cinek24ac55e2014-08-27 12:51:45 +02004061 public String getProfileOwnerNameAsUser(int userId) throws IllegalArgumentException {
Benjamin Franzbc33c822016-04-15 08:57:52 +01004062 throwIfParentInstance("getProfileOwnerNameAsUser");
Amith Yamasani38f836b2014-08-20 14:51:15 -07004063 if (mService != null) {
4064 try {
Selim Cinek24ac55e2014-08-27 12:51:45 +02004065 return mService.getProfileOwnerName(userId);
Amith Yamasani38f836b2014-08-20 14:51:15 -07004066 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07004067 throw re.rethrowFromSystemServer();
Amith Yamasani38f836b2014-08-20 14:51:15 -07004068 }
4069 }
4070 return null;
4071 }
4072
4073 /**
Sander Alewijnsef475ca32014-02-17 15:13:58 +00004074 * Called by a profile owner or device owner to add a default intent handler activity for
4075 * intents that match a certain intent filter. This activity will remain the default intent
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004076 * handler even if the set of potential event handlers for the intent filter changes and if the
4077 * intent preferences are reset.
4078 * <p>
4079 * The default disambiguation mechanism takes over if the activity is not installed (anymore).
4080 * When the activity is (re)installed, it is automatically reset as default intent handler for
4081 * the filter.
4082 * <p>
4083 * The calling device admin must be a profile owner or device owner. If it is not, a security
4084 * exception will be thrown.
Sander Alewijnsef475ca32014-02-17 15:13:58 +00004085 *
4086 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
4087 * @param filter The IntentFilter for which a default handler is added.
4088 * @param activity The Activity that is added as default intent handler.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004089 * @throws SecurityException if {@code admin} is not a device or profile owner.
Sander Alewijnsef475ca32014-02-17 15:13:58 +00004090 */
Robin Lee25e26452015-06-02 09:56:29 -07004091 public void addPersistentPreferredActivity(@NonNull ComponentName admin, IntentFilter filter,
4092 @NonNull ComponentName activity) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01004093 throwIfParentInstance("addPersistentPreferredActivity");
Sander Alewijnsef475ca32014-02-17 15:13:58 +00004094 if (mService != null) {
4095 try {
4096 mService.addPersistentPreferredActivity(admin, filter, activity);
4097 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07004098 throw e.rethrowFromSystemServer();
Sander Alewijnsef475ca32014-02-17 15:13:58 +00004099 }
4100 }
4101 }
4102
4103 /**
4104 * Called by a profile owner or device owner to remove all persistent intent handler preferences
Torne (Richard Coles)875e2102014-02-24 14:11:56 +00004105 * associated with the given package that were set by {@link #addPersistentPreferredActivity}.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004106 * <p>
4107 * The calling device admin must be a profile owner. If it is not, a security exception will be
4108 * thrown.
Sander Alewijnsef475ca32014-02-17 15:13:58 +00004109 *
4110 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
4111 * @param packageName The name of the package for which preferences are removed.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004112 * @throws SecurityException if {@code admin} is not a device or profile owner.
Sander Alewijnsef475ca32014-02-17 15:13:58 +00004113 */
Robin Lee25e26452015-06-02 09:56:29 -07004114 public void clearPackagePersistentPreferredActivities(@NonNull ComponentName admin,
Sander Alewijnsef475ca32014-02-17 15:13:58 +00004115 String packageName) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01004116 throwIfParentInstance("clearPackagePersistentPreferredActivities");
Sander Alewijnsef475ca32014-02-17 15:13:58 +00004117 if (mService != null) {
4118 try {
4119 mService.clearPackagePersistentPreferredActivities(admin, packageName);
4120 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07004121 throw e.rethrowFromSystemServer();
Sander Alewijnsef475ca32014-02-17 15:13:58 +00004122 }
4123 }
4124 }
Robin Lee66e5d962014-04-09 16:44:21 +01004125
4126 /**
Esteban Talaverabf60f722015-12-10 16:26:44 +00004127 * Called by a profile owner or device owner to grant permission to a package to manage
4128 * application restrictions for the calling user via {@link #setApplicationRestrictions} and
4129 * {@link #getApplicationRestrictions}.
4130 * <p>
4131 * This permission is persistent until it is later cleared by calling this method with a
4132 * {@code null} value or uninstalling the managing package.
Rubin Xuf03d0a62016-02-10 14:54:15 +00004133 * <p>
4134 * The supplied application restriction managing package must be installed when calling this
Victor Changcd14c0a2016-03-16 19:10:15 +00004135 * API, otherwise an {@link NameNotFoundException} will be thrown.
Esteban Talaverabf60f722015-12-10 16:26:44 +00004136 *
4137 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
4138 * @param packageName The package name which will be given access to application restrictions
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004139 * APIs. If {@code null} is given the current package will be cleared.
4140 * @throws SecurityException if {@code admin} is not a device or profile owner.
Victor Changcd14c0a2016-03-16 19:10:15 +00004141 * @throws NameNotFoundException if {@code packageName} is not found
Esteban Talaverabf60f722015-12-10 16:26:44 +00004142 */
4143 public void setApplicationRestrictionsManagingPackage(@NonNull ComponentName admin,
Victor Changcd14c0a2016-03-16 19:10:15 +00004144 @Nullable String packageName) throws NameNotFoundException {
Benjamin Franzbc33c822016-04-15 08:57:52 +01004145 throwIfParentInstance("setApplicationRestrictionsManagingPackage");
Esteban Talaverabf60f722015-12-10 16:26:44 +00004146 if (mService != null) {
4147 try {
Victor Changcd14c0a2016-03-16 19:10:15 +00004148 if (!mService.setApplicationRestrictionsManagingPackage(admin, packageName)) {
4149 throw new NameNotFoundException(packageName);
4150 }
Esteban Talaverabf60f722015-12-10 16:26:44 +00004151 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07004152 throw e.rethrowFromSystemServer();
Esteban Talaverabf60f722015-12-10 16:26:44 +00004153 }
4154 }
4155 }
4156
4157 /**
4158 * Called by a profile owner or device owner to retrieve the application restrictions managing
4159 * package for the current user, or {@code null} if none is set.
4160 *
4161 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
4162 * @return The package name allowed to manage application restrictions on the current user, or
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004163 * {@code null} if none is set.
4164 * @throws SecurityException if {@code admin} is not a device or profile owner.
Esteban Talaverabf60f722015-12-10 16:26:44 +00004165 */
4166 public String getApplicationRestrictionsManagingPackage(@NonNull ComponentName admin) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01004167 throwIfParentInstance("getApplicationRestrictionsManagingPackage");
Esteban Talaverabf60f722015-12-10 16:26:44 +00004168 if (mService != null) {
4169 try {
4170 return mService.getApplicationRestrictionsManagingPackage(admin);
4171 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07004172 throw e.rethrowFromSystemServer();
Esteban Talaverabf60f722015-12-10 16:26:44 +00004173 }
4174 }
4175 return null;
4176 }
4177
4178 /**
Esteban Talavera96895ca2016-03-16 12:00:40 +00004179 * Called by any application to find out whether it has been granted permission via
4180 * {@link #setApplicationRestrictionsManagingPackage} to manage application restrictions
4181 * for the calling user.
4182 *
4183 * <p>This is done by comparing the calling Linux uid with the uid of the package specified by
4184 * that method.
Esteban Talaverabf60f722015-12-10 16:26:44 +00004185 */
4186 public boolean isCallerApplicationRestrictionsManagingPackage() {
Benjamin Franzbc33c822016-04-15 08:57:52 +01004187 throwIfParentInstance("isCallerApplicationRestrictionsManagingPackage");
Esteban Talaverabf60f722015-12-10 16:26:44 +00004188 if (mService != null) {
4189 try {
4190 return mService.isCallerApplicationRestrictionsManagingPackage();
4191 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07004192 throw e.rethrowFromSystemServer();
Esteban Talaverabf60f722015-12-10 16:26:44 +00004193 }
4194 }
4195 return false;
4196 }
4197
4198 /**
4199 * Sets the application restrictions for a given target application running in the calling user.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004200 * <p>
4201 * The caller must be a profile or device owner on that user, or the package allowed to manage
4202 * application restrictions via {@link #setApplicationRestrictionsManagingPackage}; otherwise a
4203 * security exception will be thrown.
4204 * <p>
4205 * The provided {@link Bundle} consists of key-value pairs, where the types of values may be:
Esteban Talavera6b8e0642015-08-10 17:26:04 +01004206 * <ul>
4207 * <li>{@code boolean}
4208 * <li>{@code int}
4209 * <li>{@code String} or {@code String[]}
4210 * <li>From {@link android.os.Build.VERSION_CODES#M}, {@code Bundle} or {@code Bundle[]}
4211 * </ul>
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004212 * <p>
4213 * If the restrictions are not available yet, but may be applied in the near future, the caller
4214 * can notify the target application of that by adding
Sander Alewijnse53d63dc2014-11-07 21:43:00 +00004215 * {@link UserManager#KEY_RESTRICTIONS_PENDING} to the settings parameter.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004216 * <p>
4217 * The application restrictions are only made visible to the target application via
4218 * {@link UserManager#getApplicationRestrictions(String)}, in addition to the profile or device
4219 * owner, and the application restrictions managing package via
Esteban Talaverabf60f722015-12-10 16:26:44 +00004220 * {@link #getApplicationRestrictions}.
Robin Lee66e5d962014-04-09 16:44:21 +01004221 *
Esteban Talaverabf60f722015-12-10 16:26:44 +00004222 * @param admin Which {@link DeviceAdminReceiver} this request is associated with, or
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004223 * {@code null} if called by the application restrictions managing package.
Robin Lee66e5d962014-04-09 16:44:21 +01004224 * @param packageName The name of the package to update restricted settings for.
4225 * @param settings A {@link Bundle} to be parsed by the receiving application, conveying a new
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004226 * set of active restrictions.
4227 * @throws SecurityException if {@code admin} is not a device or profile owner.
Esteban Talaverabf60f722015-12-10 16:26:44 +00004228 * @see #setApplicationRestrictionsManagingPackage
Sander Alewijnse53d63dc2014-11-07 21:43:00 +00004229 * @see UserManager#KEY_RESTRICTIONS_PENDING
Robin Lee66e5d962014-04-09 16:44:21 +01004230 */
Esteban Talaverabf60f722015-12-10 16:26:44 +00004231 public void setApplicationRestrictions(@Nullable ComponentName admin, String packageName,
Robin Lee66e5d962014-04-09 16:44:21 +01004232 Bundle settings) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01004233 throwIfParentInstance("setApplicationRestrictions");
Robin Lee66e5d962014-04-09 16:44:21 +01004234 if (mService != null) {
4235 try {
4236 mService.setApplicationRestrictions(admin, packageName, settings);
4237 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07004238 throw e.rethrowFromSystemServer();
Robin Lee66e5d962014-04-09 16:44:21 +01004239 }
4240 }
4241 }
4242
4243 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004244 * Sets a list of configuration features to enable for a TrustAgent component. This is meant to
4245 * be used in conjunction with {@link #KEYGUARD_DISABLE_TRUST_AGENTS}, which disables all trust
4246 * agents but those enabled by this function call. If flag
Jim Millere303bf42014-08-26 17:12:29 -07004247 * {@link #KEYGUARD_DISABLE_TRUST_AGENTS} is not set, then this call has no effect.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004248 * <p>
4249 * The calling device admin must have requested
4250 * {@link DeviceAdminInfo#USES_POLICY_DISABLE_KEYGUARD_FEATURES} to be able to call this method;
4251 * if not, a security exception will be thrown.
Tony Mak089d8402016-04-05 17:42:55 +01004252 * <p>
4253 * This method can be called on the {@link DevicePolicyManager} instance returned by
4254 * {@link #getParentProfileInstance(ComponentName)} in order to set the configuration for
4255 * the parent profile.
Jim Miller604e7552014-07-18 19:00:02 -07004256 *
4257 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
Jim Millere303bf42014-08-26 17:12:29 -07004258 * @param target Component name of the agent to be enabled.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004259 * @param configuration TrustAgent-specific feature bundle. If null for any admin, agent will be
4260 * strictly disabled according to the state of the
4261 * {@link #KEYGUARD_DISABLE_TRUST_AGENTS} flag.
4262 * <p>
4263 * If {@link #KEYGUARD_DISABLE_TRUST_AGENTS} is set and options is not null for all
4264 * admins, then it's up to the TrustAgent itself to aggregate the values from all
4265 * device admins.
4266 * <p>
4267 * Consult documentation for the specific TrustAgent to determine legal options
4268 * parameters.
4269 * @throws SecurityException if {@code admin} is not an active administrator or does not use
4270 * {@link DeviceAdminInfo#USES_POLICY_DISABLE_KEYGUARD_FEATURES}
Jim Miller604e7552014-07-18 19:00:02 -07004271 */
Robin Lee25e26452015-06-02 09:56:29 -07004272 public void setTrustAgentConfiguration(@NonNull ComponentName admin,
4273 @NonNull ComponentName target, PersistableBundle configuration) {
Jim Miller604e7552014-07-18 19:00:02 -07004274 if (mService != null) {
4275 try {
Tony Mak089d8402016-04-05 17:42:55 +01004276 mService.setTrustAgentConfiguration(admin, target, configuration, mParentInstance);
Jim Miller604e7552014-07-18 19:00:02 -07004277 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07004278 throw e.rethrowFromSystemServer();
Jim Miller604e7552014-07-18 19:00:02 -07004279 }
4280 }
4281 }
4282
4283 /**
Jim Millere303bf42014-08-26 17:12:29 -07004284 * Gets configuration for the given trust agent based on aggregating all calls to
4285 * {@link #setTrustAgentConfiguration(ComponentName, ComponentName, PersistableBundle)} for
4286 * all device admins.
Tony Mak089d8402016-04-05 17:42:55 +01004287 * <p>
4288 * This method can be called on the {@link DevicePolicyManager} instance returned by
4289 * {@link #getParentProfileInstance(ComponentName)} in order to retrieve the configuration set
4290 * on the parent profile.
Jim Miller604e7552014-07-18 19:00:02 -07004291 *
Jim Millerb5db57a2015-01-14 18:17:19 -08004292 * @param admin Which {@link DeviceAdminReceiver} this request is associated with. If null,
4293 * this function returns a list of configurations for all admins that declare
4294 * {@link #KEYGUARD_DISABLE_TRUST_AGENTS}. If any admin declares
4295 * {@link #KEYGUARD_DISABLE_TRUST_AGENTS} but doesn't call
4296 * {@link #setTrustAgentConfiguration(ComponentName, ComponentName, PersistableBundle)}
4297 * for this {@param agent} or calls it with a null configuration, null is returned.
Jim Miller604e7552014-07-18 19:00:02 -07004298 * @param agent Which component to get enabled features for.
Jim Millere303bf42014-08-26 17:12:29 -07004299 * @return configuration for the given trust agent.
Jim Miller604e7552014-07-18 19:00:02 -07004300 */
Robin Lee25e26452015-06-02 09:56:29 -07004301 public List<PersistableBundle> getTrustAgentConfiguration(@Nullable ComponentName admin,
4302 @NonNull ComponentName agent) {
Makoto Onukicc4bbeb2015-09-17 10:28:24 -07004303 return getTrustAgentConfiguration(admin, agent, myUserId());
Jim Millere303bf42014-08-26 17:12:29 -07004304 }
4305
4306 /** @hide per-user version */
Robin Lee25e26452015-06-02 09:56:29 -07004307 public List<PersistableBundle> getTrustAgentConfiguration(@Nullable ComponentName admin,
4308 @NonNull ComponentName agent, int userHandle) {
Jim Miller604e7552014-07-18 19:00:02 -07004309 if (mService != null) {
4310 try {
Tony Mak089d8402016-04-05 17:42:55 +01004311 return mService.getTrustAgentConfiguration(admin, agent, userHandle,
4312 mParentInstance);
Jim Miller604e7552014-07-18 19:00:02 -07004313 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07004314 throw e.rethrowFromSystemServer();
Jim Miller604e7552014-07-18 19:00:02 -07004315 }
4316 }
Jim Millere303bf42014-08-26 17:12:29 -07004317 return new ArrayList<PersistableBundle>(); // empty list
Jim Miller604e7552014-07-18 19:00:02 -07004318 }
4319
4320 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004321 * Called by a profile owner of a managed profile to set whether caller-Id information from the
4322 * managed profile will be shown in the parent profile, for incoming calls.
4323 * <p>
4324 * The calling device admin must be a profile owner. If it is not, a security exception will be
4325 * thrown.
Adam Connors210fe212014-07-17 15:41:43 +01004326 *
Robin Lee25e26452015-06-02 09:56:29 -07004327 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
Adam Connors210fe212014-07-17 15:41:43 +01004328 * @param disabled If true caller-Id information in the managed profile is not displayed.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004329 * @throws SecurityException if {@code admin} is not a device or profile owner.
Adam Connors210fe212014-07-17 15:41:43 +01004330 */
Robin Lee25e26452015-06-02 09:56:29 -07004331 public void setCrossProfileCallerIdDisabled(@NonNull ComponentName admin, boolean disabled) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01004332 throwIfParentInstance("setCrossProfileCallerIdDisabled");
Adam Connors210fe212014-07-17 15:41:43 +01004333 if (mService != null) {
4334 try {
Robin Lee25e26452015-06-02 09:56:29 -07004335 mService.setCrossProfileCallerIdDisabled(admin, disabled);
Adam Connors210fe212014-07-17 15:41:43 +01004336 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07004337 throw e.rethrowFromSystemServer();
Adam Connors210fe212014-07-17 15:41:43 +01004338 }
4339 }
4340 }
4341
4342 /**
Amith Yamasanic34dc7c2014-09-18 09:42:42 -07004343 * Called by a profile owner of a managed profile to determine whether or not caller-Id
4344 * information has been disabled.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004345 * <p>
4346 * The calling device admin must be a profile owner. If it is not, a security exception will be
4347 * thrown.
Adam Connors210fe212014-07-17 15:41:43 +01004348 *
Robin Lee25e26452015-06-02 09:56:29 -07004349 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004350 * @throws SecurityException if {@code admin} is not a device or profile owner.
Adam Connors210fe212014-07-17 15:41:43 +01004351 */
Robin Lee25e26452015-06-02 09:56:29 -07004352 public boolean getCrossProfileCallerIdDisabled(@NonNull ComponentName admin) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01004353 throwIfParentInstance("getCrossProfileCallerIdDisabled");
Adam Connors210fe212014-07-17 15:41:43 +01004354 if (mService != null) {
4355 try {
Robin Lee25e26452015-06-02 09:56:29 -07004356 return mService.getCrossProfileCallerIdDisabled(admin);
Adam Connors210fe212014-07-17 15:41:43 +01004357 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07004358 throw e.rethrowFromSystemServer();
Adam Connors210fe212014-07-17 15:41:43 +01004359 }
4360 }
4361 return false;
4362 }
4363
4364 /**
Amith Yamasani570002f2014-07-18 15:48:54 -07004365 * Determine whether or not caller-Id information has been disabled.
4366 *
4367 * @param userHandle The user for whom to check the caller-id permission
4368 * @hide
4369 */
4370 public boolean getCrossProfileCallerIdDisabled(UserHandle userHandle) {
4371 if (mService != null) {
4372 try {
4373 return mService.getCrossProfileCallerIdDisabledForUser(userHandle.getIdentifier());
4374 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07004375 throw e.rethrowFromSystemServer();
Amith Yamasani570002f2014-07-18 15:48:54 -07004376 }
4377 }
4378 return false;
4379 }
4380
4381 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004382 * Called by a profile owner of a managed profile to set whether contacts search from the
4383 * managed profile will be shown in the parent profile, for incoming calls.
4384 * <p>
4385 * The calling device admin must be a profile owner. If it is not, a security exception will be
4386 * thrown.
Victor Chang1060c6182016-01-04 20:16:23 +00004387 *
4388 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
4389 * @param disabled If true contacts search in the managed profile is not displayed.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004390 * @throws SecurityException if {@code admin} is not a device or profile owner.
Victor Chang1060c6182016-01-04 20:16:23 +00004391 */
4392 public void setCrossProfileContactsSearchDisabled(@NonNull ComponentName admin,
4393 boolean disabled) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01004394 throwIfParentInstance("setCrossProfileContactsSearchDisabled");
Victor Chang1060c6182016-01-04 20:16:23 +00004395 if (mService != null) {
4396 try {
4397 mService.setCrossProfileContactsSearchDisabled(admin, disabled);
4398 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07004399 throw e.rethrowFromSystemServer();
Victor Chang1060c6182016-01-04 20:16:23 +00004400 }
4401 }
4402 }
4403
4404 /**
4405 * Called by a profile owner of a managed profile to determine whether or not contacts search
4406 * has been disabled.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004407 * <p>
4408 * The calling device admin must be a profile owner. If it is not, a security exception will be
4409 * thrown.
Victor Chang1060c6182016-01-04 20:16:23 +00004410 *
4411 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004412 * @throws SecurityException if {@code admin} is not a device or profile owner.
Victor Chang1060c6182016-01-04 20:16:23 +00004413 */
4414 public boolean getCrossProfileContactsSearchDisabled(@NonNull ComponentName admin) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01004415 throwIfParentInstance("getCrossProfileContactsSearchDisabled");
Victor Chang1060c6182016-01-04 20:16:23 +00004416 if (mService != null) {
4417 try {
4418 return mService.getCrossProfileContactsSearchDisabled(admin);
4419 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07004420 throw e.rethrowFromSystemServer();
Victor Chang1060c6182016-01-04 20:16:23 +00004421 }
4422 }
4423 return false;
4424 }
4425
4426
4427 /**
4428 * Determine whether or not contacts search has been disabled.
4429 *
4430 * @param userHandle The user for whom to check the contacts search permission
4431 * @hide
4432 */
4433 public boolean getCrossProfileContactsSearchDisabled(@NonNull UserHandle userHandle) {
4434 if (mService != null) {
4435 try {
4436 return mService
4437 .getCrossProfileContactsSearchDisabledForUser(userHandle.getIdentifier());
4438 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07004439 throw e.rethrowFromSystemServer();
Victor Chang1060c6182016-01-04 20:16:23 +00004440 }
4441 }
4442 return false;
4443 }
4444
4445 /**
Makoto Onuki32b30572015-12-11 14:29:51 -08004446 * Start Quick Contact on the managed profile for the user, if the policy allows.
Victor Chang97bdacc2016-01-21 22:24:11 +00004447 *
Makoto Onuki1040da12015-03-19 11:24:00 -07004448 * @hide
4449 */
4450 public void startManagedQuickContact(String actualLookupKey, long actualContactId,
Victor Chang97bdacc2016-01-21 22:24:11 +00004451 boolean isContactIdIgnored, long directoryId, Intent originalIntent) {
Makoto Onuki1040da12015-03-19 11:24:00 -07004452 if (mService != null) {
4453 try {
Victor Chang97bdacc2016-01-21 22:24:11 +00004454 mService.startManagedQuickContact(actualLookupKey, actualContactId,
4455 isContactIdIgnored, directoryId, originalIntent);
Makoto Onuki1040da12015-03-19 11:24:00 -07004456 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07004457 throw e.rethrowFromSystemServer();
Makoto Onuki1040da12015-03-19 11:24:00 -07004458 }
4459 }
4460 }
4461
4462 /**
Makoto Onuki32b30572015-12-11 14:29:51 -08004463 * Start Quick Contact on the managed profile for the user, if the policy allows.
Ricky Wai494b95d2015-11-20 16:07:15 +00004464 * @hide
4465 */
4466 public void startManagedQuickContact(String actualLookupKey, long actualContactId,
4467 Intent originalIntent) {
Victor Chang97bdacc2016-01-21 22:24:11 +00004468 startManagedQuickContact(actualLookupKey, actualContactId, false, Directory.DEFAULT,
Ricky Wai494b95d2015-11-20 16:07:15 +00004469 originalIntent);
4470 }
4471
4472 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004473 * Called by a profile owner of a managed profile to set whether bluetooth devices can access
4474 * enterprise contacts.
Ricky Wai778ba132015-03-31 14:21:22 +01004475 * <p>
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004476 * The calling device admin must be a profile owner. If it is not, a security exception will be
4477 * thrown.
Ricky Wai778ba132015-03-31 14:21:22 +01004478 * <p>
4479 * This API works on managed profile only.
4480 *
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004481 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
4482 * @param disabled If true, bluetooth devices cannot access enterprise contacts.
4483 * @throws SecurityException if {@code admin} is not a device or profile owner.
Ricky Wai778ba132015-03-31 14:21:22 +01004484 */
Robin Lee25e26452015-06-02 09:56:29 -07004485 public void setBluetoothContactSharingDisabled(@NonNull ComponentName admin, boolean disabled) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01004486 throwIfParentInstance("setBluetoothContactSharingDisabled");
Ricky Wai778ba132015-03-31 14:21:22 +01004487 if (mService != null) {
4488 try {
Robin Lee25e26452015-06-02 09:56:29 -07004489 mService.setBluetoothContactSharingDisabled(admin, disabled);
Ricky Wai778ba132015-03-31 14:21:22 +01004490 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07004491 throw e.rethrowFromSystemServer();
Ricky Wai778ba132015-03-31 14:21:22 +01004492 }
4493 }
4494 }
4495
4496 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004497 * Called by a profile owner of a managed profile to determine whether or not Bluetooth devices
4498 * cannot access enterprise contacts.
Ricky Wai778ba132015-03-31 14:21:22 +01004499 * <p>
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004500 * The calling device admin must be a profile owner. If it is not, a security exception will be
4501 * thrown.
Ricky Wai778ba132015-03-31 14:21:22 +01004502 * <p>
4503 * This API works on managed profile only.
4504 *
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004505 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
4506 * @throws SecurityException if {@code admin} is not a device or profile owner.
Ricky Wai778ba132015-03-31 14:21:22 +01004507 */
Robin Lee25e26452015-06-02 09:56:29 -07004508 public boolean getBluetoothContactSharingDisabled(@NonNull ComponentName admin) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01004509 throwIfParentInstance("getBluetoothContactSharingDisabled");
Ricky Wai778ba132015-03-31 14:21:22 +01004510 if (mService != null) {
4511 try {
Robin Lee25e26452015-06-02 09:56:29 -07004512 return mService.getBluetoothContactSharingDisabled(admin);
Ricky Wai778ba132015-03-31 14:21:22 +01004513 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07004514 throw e.rethrowFromSystemServer();
Ricky Wai778ba132015-03-31 14:21:22 +01004515 }
4516 }
4517 return true;
4518 }
4519
4520 /**
4521 * Determine whether or not Bluetooth devices cannot access contacts.
4522 * <p>
4523 * This API works on managed profile UserHandle only.
4524 *
4525 * @param userHandle The user for whom to check the caller-id permission
4526 * @hide
4527 */
4528 public boolean getBluetoothContactSharingDisabled(UserHandle userHandle) {
4529 if (mService != null) {
4530 try {
4531 return mService.getBluetoothContactSharingDisabledForUser(userHandle
4532 .getIdentifier());
4533 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07004534 throw e.rethrowFromSystemServer();
Ricky Wai778ba132015-03-31 14:21:22 +01004535 }
4536 }
4537 return true;
4538 }
4539
4540 /**
Amith Yamasanic34dc7c2014-09-18 09:42:42 -07004541 * Called by the profile owner of a managed profile so that some intents sent in the managed
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004542 * profile can also be resolved in the parent, or vice versa. Only activity intents are
4543 * supported.
Nicolas Prevotfc7b4442014-12-17 15:28:29 +00004544 *
Nicolas Prevot10fa67c2014-03-24 13:44:38 +00004545 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
Nicolas Prevot81948992014-05-16 18:25:26 +01004546 * @param filter The {@link IntentFilter} the intent has to match to be also resolved in the
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004547 * other profile
Nicolas Prevot41d926e2014-06-09 11:48:56 +01004548 * @param flags {@link DevicePolicyManager#FLAG_MANAGED_CAN_ACCESS_PARENT} and
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004549 * {@link DevicePolicyManager#FLAG_PARENT_CAN_ACCESS_MANAGED} are supported.
4550 * @throws SecurityException if {@code admin} is not a device or profile owner.
Nicolas Prevot10fa67c2014-03-24 13:44:38 +00004551 */
Robin Lee25e26452015-06-02 09:56:29 -07004552 public void addCrossProfileIntentFilter(@NonNull ComponentName admin, IntentFilter filter, int flags) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01004553 throwIfParentInstance("addCrossProfileIntentFilter");
Nicolas Prevot10fa67c2014-03-24 13:44:38 +00004554 if (mService != null) {
4555 try {
Nicolas Prevot81948992014-05-16 18:25:26 +01004556 mService.addCrossProfileIntentFilter(admin, filter, flags);
Nicolas Prevot10fa67c2014-03-24 13:44:38 +00004557 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07004558 throw e.rethrowFromSystemServer();
Nicolas Prevot10fa67c2014-03-24 13:44:38 +00004559 }
4560 }
4561 }
4562
4563 /**
Amith Yamasanic34dc7c2014-09-18 09:42:42 -07004564 * Called by a profile owner of a managed profile to remove the cross-profile intent filters
4565 * that go from the managed profile to the parent, or from the parent to the managed profile.
Nicolas Prevot3f7777f2014-07-24 15:58:39 +01004566 * Only removes those that have been set by the profile owner.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004567 *
Nicolas Prevot10fa67c2014-03-24 13:44:38 +00004568 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004569 * @throws SecurityException if {@code admin} is not a device or profile owner.
Nicolas Prevot10fa67c2014-03-24 13:44:38 +00004570 */
Robin Lee25e26452015-06-02 09:56:29 -07004571 public void clearCrossProfileIntentFilters(@NonNull ComponentName admin) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01004572 throwIfParentInstance("clearCrossProfileIntentFilters");
Nicolas Prevot10fa67c2014-03-24 13:44:38 +00004573 if (mService != null) {
4574 try {
Nicolas Prevot81948992014-05-16 18:25:26 +01004575 mService.clearCrossProfileIntentFilters(admin);
Nicolas Prevot10fa67c2014-03-24 13:44:38 +00004576 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07004577 throw e.rethrowFromSystemServer();
Nicolas Prevot10fa67c2014-03-24 13:44:38 +00004578 }
4579 }
4580 }
4581
4582 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004583 * Called by a profile or device owner to set the permitted accessibility services. When set by
4584 * a device owner or profile owner the restriction applies to all profiles of the user the
4585 * device owner or profile owner is an admin for. By default the user can use any accessiblity
4586 * service. When zero or more packages have been added, accessiblity services that are not in
4587 * the list and not part of the system can not be enabled by the user.
4588 * <p>
4589 * Calling with a null value for the list disables the restriction so that all services can be
4590 * used, calling with an empty list only allows the builtin system's services.
4591 * <p>
4592 * System accesibility services are always available to the user the list can't modify this.
Kenny Guyfa80a4f2014-08-20 19:40:59 +01004593 *
4594 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
4595 * @param packageNames List of accessibility service package names.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004596 * @return true if setting the restriction succeeded. It fail if there is one or more non-system
4597 * accessibility services enabled, that are not in the list.
4598 * @throws SecurityException if {@code admin} is not a device or profile owner.
Kenny Guyfa80a4f2014-08-20 19:40:59 +01004599 */
Robin Lee25e26452015-06-02 09:56:29 -07004600 public boolean setPermittedAccessibilityServices(@NonNull ComponentName admin,
Kenny Guyfa80a4f2014-08-20 19:40:59 +01004601 List<String> packageNames) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01004602 throwIfParentInstance("setPermittedAccessibilityServices");
Kenny Guyfa80a4f2014-08-20 19:40:59 +01004603 if (mService != null) {
4604 try {
4605 return mService.setPermittedAccessibilityServices(admin, packageNames);
4606 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07004607 throw e.rethrowFromSystemServer();
Kenny Guyfa80a4f2014-08-20 19:40:59 +01004608 }
4609 }
4610 return false;
4611 }
4612
4613 /**
4614 * Returns the list of permitted accessibility services set by this device or profile owner.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004615 * <p>
4616 * An empty list means no accessibility services except system services are allowed. Null means
4617 * all accessibility services are allowed.
Kenny Guyfa80a4f2014-08-20 19:40:59 +01004618 *
4619 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
4620 * @return List of accessiblity service package names.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004621 * @throws SecurityException if {@code admin} is not a device or profile owner.
Kenny Guyfa80a4f2014-08-20 19:40:59 +01004622 */
Robin Lee25e26452015-06-02 09:56:29 -07004623 public List<String> getPermittedAccessibilityServices(@NonNull ComponentName admin) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01004624 throwIfParentInstance("getPermittedAccessibilityServices");
Kenny Guyfa80a4f2014-08-20 19:40:59 +01004625 if (mService != null) {
4626 try {
4627 return mService.getPermittedAccessibilityServices(admin);
4628 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07004629 throw e.rethrowFromSystemServer();
Kenny Guyfa80a4f2014-08-20 19:40:59 +01004630 }
4631 }
4632 return null;
4633 }
4634
4635 /**
Sudheer Shanka56925862016-01-28 19:43:59 +00004636 * Called by the system to check if a specific accessibility service is disabled by admin.
4637 *
4638 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
4639 * @param packageName Accessibility service package name that needs to be checked.
4640 * @param userHandle user id the admin is running as.
4641 * @return true if the accessibility service is permitted, otherwise false.
4642 *
4643 * @hide
4644 */
4645 public boolean isAccessibilityServicePermittedByAdmin(@NonNull ComponentName admin,
4646 @NonNull String packageName, int userHandle) {
4647 if (mService != null) {
4648 try {
4649 return mService.isAccessibilityServicePermittedByAdmin(admin, packageName,
4650 userHandle);
4651 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07004652 throw e.rethrowFromSystemServer();
Sudheer Shanka56925862016-01-28 19:43:59 +00004653 }
4654 }
4655 return false;
4656 }
4657
4658 /**
Kenny Guyfa80a4f2014-08-20 19:40:59 +01004659 * Returns the list of accessibility services permitted by the device or profiles
4660 * owners of this user.
4661 *
4662 * <p>Null means all accessibility services are allowed, if a non-null list is returned
4663 * it will contain the intersection of the permitted lists for any device or profile
4664 * owners that apply to this user. It will also include any system accessibility services.
4665 *
4666 * @param userId which user to check for.
4667 * @return List of accessiblity service package names.
4668 * @hide
4669 */
4670 @SystemApi
4671 public List<String> getPermittedAccessibilityServices(int userId) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01004672 throwIfParentInstance("getPermittedAccessibilityServices");
Kenny Guyfa80a4f2014-08-20 19:40:59 +01004673 if (mService != null) {
4674 try {
4675 return mService.getPermittedAccessibilityServicesForUser(userId);
4676 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07004677 throw e.rethrowFromSystemServer();
Kenny Guyfa80a4f2014-08-20 19:40:59 +01004678 }
4679 }
4680 return null;
4681 }
4682
4683 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004684 * Called by a profile or device owner to set the permitted input methods services. When set by
4685 * a device owner or profile owner the restriction applies to all profiles of the user the
4686 * device owner or profile owner is an admin for. By default the user can use any input method.
4687 * When zero or more packages have been added, input method that are not in the list and not
4688 * part of the system can not be enabled by the user. This method will fail if it is called for
4689 * a admin that is not for the foreground user or a profile of the foreground user.
4690 * <p>
4691 * Calling with a null value for the list disables the restriction so that all input methods can
4692 * be used, calling with an empty list disables all but the system's own input methods.
4693 * <p>
4694 * System input methods are always available to the user this method can't modify this.
Kenny Guyfa80a4f2014-08-20 19:40:59 +01004695 *
4696 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
4697 * @param packageNames List of input method package names.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004698 * @return true if setting the restriction succeeded. It will fail if there are one or more
4699 * non-system input methods currently enabled that are not in the packageNames list.
4700 * @throws SecurityException if {@code admin} is not a device or profile owner.
Kenny Guyfa80a4f2014-08-20 19:40:59 +01004701 */
Robin Lee25e26452015-06-02 09:56:29 -07004702 public boolean setPermittedInputMethods(@NonNull ComponentName admin, List<String> packageNames) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01004703 throwIfParentInstance("setPermittedInputMethods");
Kenny Guyfa80a4f2014-08-20 19:40:59 +01004704 if (mService != null) {
4705 try {
4706 return mService.setPermittedInputMethods(admin, packageNames);
4707 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07004708 throw e.rethrowFromSystemServer();
Kenny Guyfa80a4f2014-08-20 19:40:59 +01004709 }
4710 }
4711 return false;
4712 }
4713
4714
4715 /**
4716 * Returns the list of permitted input methods set by this device or profile owner.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004717 * <p>
4718 * An empty list means no input methods except system input methods are allowed. Null means all
4719 * input methods are allowed.
Kenny Guyfa80a4f2014-08-20 19:40:59 +01004720 *
4721 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
4722 * @return List of input method package names.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004723 * @throws SecurityException if {@code admin} is not a device or profile owner.
Kenny Guyfa80a4f2014-08-20 19:40:59 +01004724 */
Robin Lee25e26452015-06-02 09:56:29 -07004725 public List<String> getPermittedInputMethods(@NonNull ComponentName admin) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01004726 throwIfParentInstance("getPermittedInputMethods");
Kenny Guyfa80a4f2014-08-20 19:40:59 +01004727 if (mService != null) {
4728 try {
4729 return mService.getPermittedInputMethods(admin);
4730 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07004731 throw e.rethrowFromSystemServer();
Kenny Guyfa80a4f2014-08-20 19:40:59 +01004732 }
4733 }
4734 return null;
4735 }
4736
4737 /**
Sudheer Shanka56925862016-01-28 19:43:59 +00004738 * Called by the system to check if a specific input method is disabled by admin.
4739 *
4740 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
4741 * @param packageName Input method package name that needs to be checked.
4742 * @param userHandle user id the admin is running as.
4743 * @return true if the input method is permitted, otherwise false.
4744 *
4745 * @hide
4746 */
4747 public boolean isInputMethodPermittedByAdmin(@NonNull ComponentName admin,
4748 @NonNull String packageName, int userHandle) {
4749 if (mService != null) {
4750 try {
4751 return mService.isInputMethodPermittedByAdmin(admin, packageName, userHandle);
4752 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07004753 throw e.rethrowFromSystemServer();
Sudheer Shanka56925862016-01-28 19:43:59 +00004754 }
4755 }
4756 return false;
4757 }
4758
4759 /**
Kenny Guyfa80a4f2014-08-20 19:40:59 +01004760 * Returns the list of input methods permitted by the device or profiles
Makoto Onuki32b30572015-12-11 14:29:51 -08004761 * owners of the current user. (*Not* calling user, due to a limitation in InputMethodManager.)
Kenny Guyfa80a4f2014-08-20 19:40:59 +01004762 *
4763 * <p>Null means all input methods are allowed, if a non-null list is returned
4764 * it will contain the intersection of the permitted lists for any device or profile
4765 * owners that apply to this user. It will also include any system input methods.
4766 *
4767 * @return List of input method package names.
4768 * @hide
4769 */
4770 @SystemApi
4771 public List<String> getPermittedInputMethodsForCurrentUser() {
Benjamin Franzbc33c822016-04-15 08:57:52 +01004772 throwIfParentInstance("getPermittedInputMethodsForCurrentUser");
Kenny Guyfa80a4f2014-08-20 19:40:59 +01004773 if (mService != null) {
4774 try {
4775 return mService.getPermittedInputMethodsForCurrentUser();
4776 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07004777 throw e.rethrowFromSystemServer();
Kenny Guyfa80a4f2014-08-20 19:40:59 +01004778 }
4779 }
4780 return null;
4781 }
4782
4783 /**
Fyodor Kupolovcb6fd802015-11-05 14:27:06 -08004784 * Called by a device owner to get the list of apps to keep around as APKs even if no user has
4785 * currently installed it.
4786 *
4787 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
4788 *
4789 * @return List of package names to keep cached.
4790 * @hide
4791 */
4792 public List<String> getKeepUninstalledPackages(@NonNull ComponentName admin) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01004793 throwIfParentInstance("getKeepUninstalledPackages");
Fyodor Kupolovcb6fd802015-11-05 14:27:06 -08004794 if (mService != null) {
4795 try {
4796 return mService.getKeepUninstalledPackages(admin);
4797 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07004798 throw e.rethrowFromSystemServer();
Fyodor Kupolovcb6fd802015-11-05 14:27:06 -08004799 }
4800 }
4801 return null;
4802 }
4803
4804 /**
4805 * Called by a device owner to set a list of apps to keep around as APKs even if no user has
4806 * currently installed it.
4807 *
4808 * <p>Please note that setting this policy does not imply that specified apps will be
4809 * automatically pre-cached.</p>
4810 *
4811 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
4812 * @param packageNames List of package names to keep cached.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004813 * @throws SecurityException if {@code admin} is not a device owner.
Fyodor Kupolovcb6fd802015-11-05 14:27:06 -08004814 * @hide
4815 */
4816 public void setKeepUninstalledPackages(@NonNull ComponentName admin,
4817 @NonNull List<String> packageNames) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01004818 throwIfParentInstance("setKeepUninstalledPackages");
Fyodor Kupolovcb6fd802015-11-05 14:27:06 -08004819 if (mService != null) {
4820 try {
4821 mService.setKeepUninstalledPackages(admin, packageNames);
4822 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07004823 throw e.rethrowFromSystemServer();
Fyodor Kupolovcb6fd802015-11-05 14:27:06 -08004824 }
4825 }
4826 }
4827
4828 /**
Julia Reynolds1e958392014-05-16 14:25:21 -04004829 * Called by a device owner to create a user with the specified name. The UserHandle returned
4830 * by this method should not be persisted as user handles are recycled as users are removed and
4831 * created. If you need to persist an identifier for this user, use
4832 * {@link UserManager#getSerialNumberForUser}.
4833 *
4834 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
4835 * @param name the user's name
4836 * @see UserHandle
Robin Lee25e26452015-06-02 09:56:29 -07004837 * @return the {@link android.os.UserHandle} object for the created user, or {@code null} if the
4838 * user could not be created.
Kenny Guy14f48e52015-06-29 15:12:36 +01004839 *
Dianne Hackborn0e3de6c2015-07-29 15:20:21 -07004840 * @deprecated From {@link android.os.Build.VERSION_CODES#M}
phweiss27ee3342016-02-08 16:40:45 +01004841 * @removed From {@link android.os.Build.VERSION_CODES#N}
Julia Reynolds1e958392014-05-16 14:25:21 -04004842 */
Kenny Guy14f48e52015-06-29 15:12:36 +01004843 @Deprecated
Robin Lee25e26452015-06-02 09:56:29 -07004844 public UserHandle createUser(@NonNull ComponentName admin, String name) {
Julia Reynolds1e958392014-05-16 14:25:21 -04004845 return null;
4846 }
4847
4848 /**
Jason Monk03978a42014-06-10 15:05:30 -04004849 * Called by a device owner to create a user with the specified name. The UserHandle returned
4850 * by this method should not be persisted as user handles are recycled as users are removed and
4851 * created. If you need to persist an identifier for this user, use
4852 * {@link UserManager#getSerialNumberForUser}. The new user will be started in the background
4853 * immediately.
4854 *
4855 * <p> profileOwnerComponent is the {@link DeviceAdminReceiver} to be the profile owner as well
4856 * as registered as an active admin on the new user. The profile owner package will be
4857 * installed on the new user if it already is installed on the device.
4858 *
4859 * <p>If the optionalInitializeData is not null, then the extras will be passed to the
4860 * profileOwnerComponent when onEnable is called.
4861 *
4862 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
4863 * @param name the user's name
4864 * @param ownerName the human readable name of the organisation associated with this DPM.
4865 * @param profileOwnerComponent The {@link DeviceAdminReceiver} that will be an active admin on
4866 * the user.
4867 * @param adminExtras Extras that will be passed to onEnable of the admin receiver
4868 * on the new user.
4869 * @see UserHandle
Robin Lee25e26452015-06-02 09:56:29 -07004870 * @return the {@link android.os.UserHandle} object for the created user, or {@code null} if the
4871 * user could not be created.
Kenny Guy14f48e52015-06-29 15:12:36 +01004872 *
Dianne Hackborn0e3de6c2015-07-29 15:20:21 -07004873 * @deprecated From {@link android.os.Build.VERSION_CODES#M}
phweiss27ee3342016-02-08 16:40:45 +01004874 * @removed From {@link android.os.Build.VERSION_CODES#N}
Jason Monk03978a42014-06-10 15:05:30 -04004875 */
Kenny Guy14f48e52015-06-29 15:12:36 +01004876 @Deprecated
Robin Lee25e26452015-06-02 09:56:29 -07004877 public UserHandle createAndInitializeUser(@NonNull ComponentName admin, String name,
4878 String ownerName, @NonNull ComponentName profileOwnerComponent, Bundle adminExtras) {
Jason Monk03978a42014-06-10 15:05:30 -04004879 return null;
4880 }
4881
4882 /**
phweissa92e1212016-01-25 17:14:10 +01004883 * Flag used by {@link #createAndManageUser} to skip setup wizard after creating a new user.
phweiss343fb332016-01-25 14:48:59 +01004884 */
4885 public static final int SKIP_SETUP_WIZARD = 0x0001;
4886
4887 /**
Lenka Trochtovac8202c82016-01-26 15:11:09 +01004888 * Flag used by {@link #createAndManageUser} to specify that the user should be created
4889 * ephemeral.
4890 * @hide
4891 */
4892 public static final int MAKE_USER_EPHEMERAL = 0x0002;
4893
4894 /**
phweissa92e1212016-01-25 17:14:10 +01004895 * Called by a device owner to create a user with the specified name and a given component of
4896 * the calling package as profile owner. The UserHandle returned by this method should not be
4897 * persisted as user handles are recycled as users are removed and created. If you need to
4898 * persist an identifier for this user, use {@link UserManager#getSerialNumberForUser}. The new
4899 * user will not be started in the background.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004900 * <p>
4901 * admin is the {@link DeviceAdminReceiver} which is the device owner. profileOwner is also a
4902 * DeviceAdminReceiver in the same package as admin, and will become the profile owner and will
4903 * be registered as an active admin on the new user. The profile owner package will be installed
4904 * on the new user.
4905 * <p>
4906 * If the adminExtras are not null, they will be stored on the device until the user is started
4907 * for the first time. Then the extras will be passed to the admin when onEnable is called.
phweiss343fb332016-01-25 14:48:59 +01004908 *
4909 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
4910 * @param name The user's name.
phweissa92e1212016-01-25 17:14:10 +01004911 * @param profileOwner Which {@link DeviceAdminReceiver} will be profile owner. Has to be in the
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004912 * same package as admin, otherwise no user is created and an
4913 * IllegalArgumentException is thrown.
phweiss343fb332016-01-25 14:48:59 +01004914 * @param adminExtras Extras that will be passed to onEnable of the admin receiver on the new
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004915 * user.
phweissa92e1212016-01-25 17:14:10 +01004916 * @param flags {@link #SKIP_SETUP_WIZARD} is supported.
phweiss343fb332016-01-25 14:48:59 +01004917 * @see UserHandle
4918 * @return the {@link android.os.UserHandle} object for the created user, or {@code null} if the
4919 * user could not be created.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004920 * @throws SecurityException if {@code admin} is not a device owner.
phweiss343fb332016-01-25 14:48:59 +01004921 */
4922 public UserHandle createAndManageUser(@NonNull ComponentName admin, @NonNull String name,
phweissa92e1212016-01-25 17:14:10 +01004923 @NonNull ComponentName profileOwner, @Nullable PersistableBundle adminExtras,
4924 int flags) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01004925 throwIfParentInstance("createAndManageUser");
phweiss343fb332016-01-25 14:48:59 +01004926 try {
phweissa92e1212016-01-25 17:14:10 +01004927 return mService.createAndManageUser(admin, name, profileOwner, adminExtras, flags);
phweiss343fb332016-01-25 14:48:59 +01004928 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07004929 throw re.rethrowFromSystemServer();
phweiss343fb332016-01-25 14:48:59 +01004930 }
phweiss343fb332016-01-25 14:48:59 +01004931 }
4932
4933 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004934 * Called by a device owner to remove a user and all associated data. The primary user can not
4935 * be removed.
Julia Reynolds1e958392014-05-16 14:25:21 -04004936 *
4937 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
4938 * @param userHandle the user to remove.
4939 * @return {@code true} if the user was removed, {@code false} otherwise.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004940 * @throws SecurityException if {@code admin} is not a device owner.
Julia Reynolds1e958392014-05-16 14:25:21 -04004941 */
Robin Lee25e26452015-06-02 09:56:29 -07004942 public boolean removeUser(@NonNull ComponentName admin, UserHandle userHandle) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01004943 throwIfParentInstance("removeUser");
Julia Reynolds1e958392014-05-16 14:25:21 -04004944 try {
4945 return mService.removeUser(admin, userHandle);
4946 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07004947 throw re.rethrowFromSystemServer();
Julia Reynolds1e958392014-05-16 14:25:21 -04004948 }
4949 }
4950
4951 /**
Jason Monk582d9112014-07-09 19:57:08 -04004952 * Called by a device owner to switch the specified user to the foreground.
4953 *
4954 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
4955 * @param userHandle the user to switch to; null will switch to primary.
4956 * @return {@code true} if the switch was successful, {@code false} otherwise.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004957 * @throws SecurityException if {@code admin} is not a device owner.
Jason Monk582d9112014-07-09 19:57:08 -04004958 * @see Intent#ACTION_USER_FOREGROUND
4959 */
Robin Lee25e26452015-06-02 09:56:29 -07004960 public boolean switchUser(@NonNull ComponentName admin, @Nullable UserHandle userHandle) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01004961 throwIfParentInstance("switchUser");
Jason Monk582d9112014-07-09 19:57:08 -04004962 try {
4963 return mService.switchUser(admin, userHandle);
4964 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07004965 throw re.rethrowFromSystemServer();
Jason Monk582d9112014-07-09 19:57:08 -04004966 }
4967 }
4968
4969 /**
Esteban Talaverabf60f722015-12-10 16:26:44 +00004970 * Retrieves the application restrictions for a given target application running in the calling
4971 * user.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004972 * <p>
4973 * The caller must be a profile or device owner on that user, or the package allowed to manage
4974 * application restrictions via {@link #setApplicationRestrictionsManagingPackage}; otherwise a
4975 * security exception will be thrown.
Robin Lee66e5d962014-04-09 16:44:21 +01004976 *
Esteban Talaverabf60f722015-12-10 16:26:44 +00004977 * @param admin Which {@link DeviceAdminReceiver} this request is associated with, or
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004978 * {@code null} if called by the application restrictions managing package.
Robin Lee66e5d962014-04-09 16:44:21 +01004979 * @param packageName The name of the package to fetch restricted settings of.
4980 * @return {@link Bundle} of settings corresponding to what was set last time
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004981 * {@link DevicePolicyManager#setApplicationRestrictions} was called, or an empty
4982 * {@link Bundle} if no restrictions have been set.
4983 * @throws SecurityException if {@code admin} is not a device or profile owner.
Esteban Talaverabf60f722015-12-10 16:26:44 +00004984 * @see {@link #setApplicationRestrictionsManagingPackage}
Robin Lee66e5d962014-04-09 16:44:21 +01004985 */
Esteban Talaverabf60f722015-12-10 16:26:44 +00004986 public Bundle getApplicationRestrictions(@Nullable ComponentName admin, String packageName) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01004987 throwIfParentInstance("getApplicationRestrictions");
Robin Lee66e5d962014-04-09 16:44:21 +01004988 if (mService != null) {
4989 try {
4990 return mService.getApplicationRestrictions(admin, packageName);
4991 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07004992 throw e.rethrowFromSystemServer();
Robin Lee66e5d962014-04-09 16:44:21 +01004993 }
4994 }
4995 return null;
4996 }
Amith Yamasanibe465322014-04-24 13:45:17 -07004997
4998 /**
Julia Reynolds20118f12015-02-11 12:34:08 -05004999 * Called by a profile or device owner to set a user restriction specified by the key.
Amith Yamasanibe465322014-04-24 13:45:17 -07005000 * <p>
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005001 * The calling device admin must be a profile or device owner; if it is not, a security
5002 * exception will be thrown.
Jim Millerdf2258b2014-04-27 20:10:26 -07005003 *
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005004 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
5005 * @param key The key of the restriction. See the constants in {@link android.os.UserManager}
5006 * for the list of keys.
5007 * @throws SecurityException if {@code admin} is not a device or profile owner.
Amith Yamasanibe465322014-04-24 13:45:17 -07005008 */
Robin Lee25e26452015-06-02 09:56:29 -07005009 public void addUserRestriction(@NonNull ComponentName admin, String key) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01005010 throwIfParentInstance("addUserRestriction");
Amith Yamasanibe465322014-04-24 13:45:17 -07005011 if (mService != null) {
5012 try {
5013 mService.setUserRestriction(admin, key, true);
5014 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07005015 throw e.rethrowFromSystemServer();
Amith Yamasanibe465322014-04-24 13:45:17 -07005016 }
5017 }
5018 }
5019
5020 /**
Julia Reynolds20118f12015-02-11 12:34:08 -05005021 * Called by a profile or device owner to clear a user restriction specified by the key.
Amith Yamasanibe465322014-04-24 13:45:17 -07005022 * <p>
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005023 * The calling device admin must be a profile or device owner; if it is not, a security
5024 * exception will be thrown.
Jim Millerdf2258b2014-04-27 20:10:26 -07005025 *
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005026 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
5027 * @param key The key of the restriction. See the constants in {@link android.os.UserManager}
5028 * for the list of keys.
5029 * @throws SecurityException if {@code admin} is not a device or profile owner.
Amith Yamasanibe465322014-04-24 13:45:17 -07005030 */
Robin Lee25e26452015-06-02 09:56:29 -07005031 public void clearUserRestriction(@NonNull ComponentName admin, String key) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01005032 throwIfParentInstance("clearUserRestriction");
Amith Yamasanibe465322014-04-24 13:45:17 -07005033 if (mService != null) {
5034 try {
5035 mService.setUserRestriction(admin, key, false);
5036 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07005037 throw e.rethrowFromSystemServer();
Amith Yamasanibe465322014-04-24 13:45:17 -07005038 }
5039 }
5040 }
Adam Connors010cfd42014-04-16 12:48:13 +01005041
5042 /**
Makoto Onuki3a3092f2015-10-30 11:07:51 -07005043 * Called by a profile or device owner to get user restrictions set with
5044 * {@link #addUserRestriction(ComponentName, String)}.
5045 * <p>
5046 * The target user may have more restrictions set by the system or other device owner / profile
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005047 * owner. To get all the user restrictions currently set, use
Makoto Onuki3a3092f2015-10-30 11:07:51 -07005048 * {@link UserManager#getUserRestrictions()}.
5049 *
5050 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005051 * @throws SecurityException if {@code admin} is not a device or profile owner.
Makoto Onuki3a3092f2015-10-30 11:07:51 -07005052 */
5053 public Bundle getUserRestrictions(@NonNull ComponentName admin) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01005054 throwIfParentInstance("getUserRestrictions");
Makoto Onuki3a3092f2015-10-30 11:07:51 -07005055 Bundle ret = null;
5056 if (mService != null) {
5057 try {
Sudheer Shanka549b9692016-03-30 17:12:07 -07005058 ret = mService.getUserRestrictions(admin);
5059 } catch (RemoteException e) {
5060 throw e.rethrowFromSystemServer();
5061 }
5062 }
5063 return ret == null ? new Bundle() : ret;
5064 }
5065
5066 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005067 * Called by profile or device owners to hide or unhide packages. When a package is hidden it is
5068 * unavailable for use, but the data and actual package file remain.
Julia Reynolds966881e2014-05-14 12:23:08 -04005069 *
5070 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
Amith Yamasanie5bcff62014-07-19 15:44:09 -07005071 * @param packageName The name of the package to hide or unhide.
5072 * @param hidden {@code true} if the package should be hidden, {@code false} if it should be
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005073 * unhidden.
Amith Yamasanie5bcff62014-07-19 15:44:09 -07005074 * @return boolean Whether the hidden setting of the package was successfully updated.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005075 * @throws SecurityException if {@code admin} is not a device or profile owner.
Julia Reynolds966881e2014-05-14 12:23:08 -04005076 */
Robin Lee25e26452015-06-02 09:56:29 -07005077 public boolean setApplicationHidden(@NonNull ComponentName admin, String packageName,
Amith Yamasanie5bcff62014-07-19 15:44:09 -07005078 boolean hidden) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01005079 throwIfParentInstance("setApplicationHidden");
Julia Reynolds966881e2014-05-14 12:23:08 -04005080 if (mService != null) {
5081 try {
Amith Yamasanie5bcff62014-07-19 15:44:09 -07005082 return mService.setApplicationHidden(admin, packageName, hidden);
Julia Reynolds966881e2014-05-14 12:23:08 -04005083 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07005084 throw e.rethrowFromSystemServer();
Julia Reynolds966881e2014-05-14 12:23:08 -04005085 }
5086 }
5087 return false;
5088 }
5089
5090 /**
Julia Reynolds20118f12015-02-11 12:34:08 -05005091 * Called by profile or device owners to determine if a package is hidden.
Julia Reynolds966881e2014-05-14 12:23:08 -04005092 *
5093 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
Amith Yamasanie5bcff62014-07-19 15:44:09 -07005094 * @param packageName The name of the package to retrieve the hidden status of.
5095 * @return boolean {@code true} if the package is hidden, {@code false} otherwise.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005096 * @throws SecurityException if {@code admin} is not a device or profile owner.
Julia Reynolds966881e2014-05-14 12:23:08 -04005097 */
Robin Lee25e26452015-06-02 09:56:29 -07005098 public boolean isApplicationHidden(@NonNull ComponentName admin, String packageName) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01005099 throwIfParentInstance("isApplicationHidden");
Julia Reynolds966881e2014-05-14 12:23:08 -04005100 if (mService != null) {
5101 try {
Amith Yamasanie5bcff62014-07-19 15:44:09 -07005102 return mService.isApplicationHidden(admin, packageName);
Julia Reynolds966881e2014-05-14 12:23:08 -04005103 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07005104 throw e.rethrowFromSystemServer();
Julia Reynolds966881e2014-05-14 12:23:08 -04005105 }
5106 }
5107 return false;
5108 }
5109
5110 /**
Julia Reynolds20118f12015-02-11 12:34:08 -05005111 * Called by profile or device owners to re-enable a system app that was disabled by default
Amith Yamasanic34dc7c2014-09-18 09:42:42 -07005112 * when the user was initialized.
Adam Connors655be2a2014-07-14 09:01:25 +00005113 *
5114 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
Makoto Onuki32b30572015-12-11 14:29:51 -08005115 * @param packageName The package to be re-enabled in the calling profile.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005116 * @throws SecurityException if {@code admin} is not a device or profile owner.
Adam Connors655be2a2014-07-14 09:01:25 +00005117 */
Robin Lee25e26452015-06-02 09:56:29 -07005118 public void enableSystemApp(@NonNull ComponentName admin, String packageName) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01005119 throwIfParentInstance("enableSystemApp");
Adam Connors655be2a2014-07-14 09:01:25 +00005120 if (mService != null) {
5121 try {
5122 mService.enableSystemApp(admin, packageName);
5123 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07005124 throw e.rethrowFromSystemServer();
Adam Connors655be2a2014-07-14 09:01:25 +00005125 }
5126 }
5127 }
5128
5129 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005130 * Called by profile or device owners to re-enable system apps by intent that were disabled by
5131 * default when the user was initialized.
Adam Connors655be2a2014-07-14 09:01:25 +00005132 *
5133 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
5134 * @param intent An intent matching the app(s) to be installed. All apps that resolve for this
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005135 * intent will be re-enabled in the calling profile.
Adam Connors655be2a2014-07-14 09:01:25 +00005136 * @return int The number of activities that matched the intent and were installed.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005137 * @throws SecurityException if {@code admin} is not a device or profile owner.
Adam Connors655be2a2014-07-14 09:01:25 +00005138 */
Robin Lee25e26452015-06-02 09:56:29 -07005139 public int enableSystemApp(@NonNull ComponentName admin, Intent intent) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01005140 throwIfParentInstance("enableSystemApp");
Adam Connors655be2a2014-07-14 09:01:25 +00005141 if (mService != null) {
5142 try {
5143 return mService.enableSystemAppWithIntent(admin, intent);
5144 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07005145 throw e.rethrowFromSystemServer();
Adam Connors655be2a2014-07-14 09:01:25 +00005146 }
5147 }
5148 return 0;
5149 }
5150
5151 /**
Sander Alewijnse112e0532014-10-29 13:28:49 +00005152 * Called by a device owner or profile owner to disable account management for a specific type
5153 * of account.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005154 * <p>
5155 * The calling device admin must be a device owner or profile owner. If it is not, a security
5156 * exception will be thrown.
5157 * <p>
5158 * When account management is disabled for an account type, adding or removing an account of
5159 * that type will not be possible.
5160 * <p>
5161 * From {@link android.os.Build.VERSION_CODES#N} the profile or device owner can still use
Benjamin Franzb6c0ce42015-11-05 10:06:51 +00005162 * {@link android.accounts.AccountManager} APIs to add or remove accounts when account
5163 * management for a specific type is disabled.
5164 *
Sander Alewijnse650c3342014-05-08 18:00:50 +01005165 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
5166 * @param accountType For which account management is disabled or enabled.
5167 * @param disabled The boolean indicating that account management will be disabled (true) or
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005168 * enabled (false).
5169 * @throws SecurityException if {@code admin} is not a device or profile owner.
Sander Alewijnse650c3342014-05-08 18:00:50 +01005170 */
Robin Lee25e26452015-06-02 09:56:29 -07005171 public void setAccountManagementDisabled(@NonNull ComponentName admin, String accountType,
Sander Alewijnse650c3342014-05-08 18:00:50 +01005172 boolean disabled) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01005173 throwIfParentInstance("setAccountManagementDisabled");
Sander Alewijnse650c3342014-05-08 18:00:50 +01005174 if (mService != null) {
5175 try {
5176 mService.setAccountManagementDisabled(admin, accountType, disabled);
5177 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07005178 throw e.rethrowFromSystemServer();
Sander Alewijnse650c3342014-05-08 18:00:50 +01005179 }
5180 }
5181 }
5182
5183 /**
Sander Alewijnse5c02db62014-05-07 10:46:57 +01005184 * Gets the array of accounts for which account management is disabled by the profile owner.
5185 *
5186 * <p> Account management can be disabled/enabled by calling
5187 * {@link #setAccountManagementDisabled}.
5188 *
5189 * @return a list of account types for which account management has been disabled.
5190 *
5191 * @see #setAccountManagementDisabled
5192 */
5193 public String[] getAccountTypesWithManagementDisabled() {
Benjamin Franzbc33c822016-04-15 08:57:52 +01005194 throwIfParentInstance("getAccountTypesWithManagementDisabled");
Makoto Onukicc4bbeb2015-09-17 10:28:24 -07005195 return getAccountTypesWithManagementDisabledAsUser(myUserId());
Alexandra Gherghina999d3942014-07-03 11:40:08 +01005196 }
5197
5198 /**
5199 * @see #getAccountTypesWithManagementDisabled()
5200 * @hide
5201 */
5202 public String[] getAccountTypesWithManagementDisabledAsUser(int userId) {
Sander Alewijnse5c02db62014-05-07 10:46:57 +01005203 if (mService != null) {
5204 try {
Alexandra Gherghina999d3942014-07-03 11:40:08 +01005205 return mService.getAccountTypesWithManagementDisabledAsUser(userId);
Sander Alewijnse5c02db62014-05-07 10:46:57 +01005206 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07005207 throw e.rethrowFromSystemServer();
Sander Alewijnse5c02db62014-05-07 10:46:57 +01005208 }
5209 }
5210
5211 return null;
5212 }
justinzhang511e0d82014-03-24 16:09:24 -04005213
5214 /**
Jason Monkd7b86212014-06-16 13:15:38 -04005215 * Sets which packages may enter lock task mode.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005216 * <p>
5217 * Any packages that shares uid with an allowed package will also be allowed to activate lock
5218 * task. From {@link android.os.Build.VERSION_CODES#M} removing packages from the lock task
5219 * package list results in locked tasks belonging to those packages to be finished. This
5220 * function can only be called by the device owner.
Jason Monkd7b86212014-06-16 13:15:38 -04005221 *
Jason Monkd7b86212014-06-16 13:15:38 -04005222 * @param packages The list of packages allowed to enter lock task mode
Jason Monk48aacba2014-08-13 16:29:08 -04005223 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005224 * @throws SecurityException if {@code admin} is not a device owner.
Jason Monkd7b86212014-06-16 13:15:38 -04005225 * @see Activity#startLockTask()
Benjamin Franz6cdb27e2015-02-26 12:26:53 +00005226 * @see DeviceAdminReceiver#onLockTaskModeEntering(Context, Intent, String)
5227 * @see DeviceAdminReceiver#onLockTaskModeExiting(Context, Intent)
Jason Monk1c7c3192014-06-26 12:52:18 -04005228 * @see UserManager#DISALLOW_CREATE_WINDOWS
justinzhang511e0d82014-03-24 16:09:24 -04005229 */
Robin Lee25e26452015-06-02 09:56:29 -07005230 public void setLockTaskPackages(@NonNull ComponentName admin, String[] packages)
Jason Monk48aacba2014-08-13 16:29:08 -04005231 throws SecurityException {
Benjamin Franzbc33c822016-04-15 08:57:52 +01005232 throwIfParentInstance("setLockTaskPackages");
justinzhang511e0d82014-03-24 16:09:24 -04005233 if (mService != null) {
5234 try {
Jason Monk48aacba2014-08-13 16:29:08 -04005235 mService.setLockTaskPackages(admin, packages);
justinzhang511e0d82014-03-24 16:09:24 -04005236 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07005237 throw e.rethrowFromSystemServer();
justinzhang511e0d82014-03-24 16:09:24 -04005238 }
5239 }
5240 }
5241
5242 /**
Jason Monkd7b86212014-06-16 13:15:38 -04005243 * This function returns the list of packages allowed to start the lock task mode.
Jason Monk48aacba2014-08-13 16:29:08 -04005244 *
5245 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
justinzhang511e0d82014-03-24 16:09:24 -04005246 * @hide
5247 */
Robin Lee25e26452015-06-02 09:56:29 -07005248 public String[] getLockTaskPackages(@NonNull ComponentName admin) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01005249 throwIfParentInstance("getLockTaskPackages");
justinzhang511e0d82014-03-24 16:09:24 -04005250 if (mService != null) {
5251 try {
Jason Monk48aacba2014-08-13 16:29:08 -04005252 return mService.getLockTaskPackages(admin);
justinzhang511e0d82014-03-24 16:09:24 -04005253 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07005254 throw e.rethrowFromSystemServer();
justinzhang511e0d82014-03-24 16:09:24 -04005255 }
5256 }
5257 return null;
5258 }
5259
5260 /**
5261 * This function lets the caller know whether the given component is allowed to start the
5262 * lock task mode.
Jason Monkd7b86212014-06-16 13:15:38 -04005263 * @param pkg The package to check
justinzhang511e0d82014-03-24 16:09:24 -04005264 */
Jason Monkd7b86212014-06-16 13:15:38 -04005265 public boolean isLockTaskPermitted(String pkg) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01005266 throwIfParentInstance("isLockTaskPermitted");
justinzhang511e0d82014-03-24 16:09:24 -04005267 if (mService != null) {
5268 try {
Jason Monkd7b86212014-06-16 13:15:38 -04005269 return mService.isLockTaskPermitted(pkg);
justinzhang511e0d82014-03-24 16:09:24 -04005270 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07005271 throw e.rethrowFromSystemServer();
justinzhang511e0d82014-03-24 16:09:24 -04005272 }
5273 }
5274 return false;
5275 }
Julia Reynoldsda551652014-05-14 17:15:16 -04005276
5277 /**
5278 * Called by device owners to update {@link Settings.Global} settings. Validation that the value
5279 * 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 -07005280 * <p>
5281 * The settings that can be updated with this method are:
Julia Reynolds9ed66da2014-08-26 15:42:03 -04005282 * <ul>
5283 * <li>{@link Settings.Global#ADB_ENABLED}</li>
5284 * <li>{@link Settings.Global#AUTO_TIME}</li>
5285 * <li>{@link Settings.Global#AUTO_TIME_ZONE}</li>
Julia Reynolds9ed66da2014-08-26 15:42:03 -04005286 * <li>{@link Settings.Global#DATA_ROAMING}</li>
Julia Reynolds9ed66da2014-08-26 15:42:03 -04005287 * <li>{@link Settings.Global#USB_MASS_STORAGE_ENABLED}</li>
Julia Reynolds9ed66da2014-08-26 15:42:03 -04005288 * <li>{@link Settings.Global#WIFI_SLEEP_POLICY}</li>
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005289 * <li>{@link Settings.Global#STAY_ON_WHILE_PLUGGED_IN} This setting is only available from
5290 * {@link android.os.Build.VERSION_CODES#M} onwards and can only be set if
5291 * {@link #setMaximumTimeToLock} is not used to set a timeout.</li>
5292 * <li>{@link Settings.Global#WIFI_DEVICE_OWNER_CONFIGS_LOCKDOWN}</li> This setting is only
5293 * available from {@link android.os.Build.VERSION_CODES#M} onwards.</li>
Julia Reynolds9ed66da2014-08-26 15:42:03 -04005294 * </ul>
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005295 * <p>
5296 * Changing the following settings has no effect as of {@link android.os.Build.VERSION_CODES#M}:
Esteban Talavera656fa7f2015-06-29 17:41:39 +01005297 * <ul>
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005298 * <li>{@link Settings.Global#BLUETOOTH_ON}. Use
5299 * {@link android.bluetooth.BluetoothAdapter#enable()} and
5300 * {@link android.bluetooth.BluetoothAdapter#disable()} instead.</li>
Esteban Talavera656fa7f2015-06-29 17:41:39 +01005301 * <li>{@link Settings.Global#DEVELOPMENT_SETTINGS_ENABLED}</li>
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005302 * <li>{@link Settings.Global#MODE_RINGER}. Use
5303 * {@link android.media.AudioManager#setRingerMode(int)} instead.</li>
Esteban Talavera656fa7f2015-06-29 17:41:39 +01005304 * <li>{@link Settings.Global#NETWORK_PREFERENCE}</li>
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005305 * <li>{@link Settings.Global#WIFI_ON}. Use
5306 * {@link android.net.wifi.WifiManager#setWifiEnabled(boolean)} instead.</li>
Esteban Talavera656fa7f2015-06-29 17:41:39 +01005307 * </ul>
Julia Reynoldsda551652014-05-14 17:15:16 -04005308 *
5309 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
5310 * @param setting The name of the setting to update.
5311 * @param value The value to update the setting to.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005312 * @throws SecurityException if {@code admin} is not a device owner.
Julia Reynoldsda551652014-05-14 17:15:16 -04005313 */
Robin Lee25e26452015-06-02 09:56:29 -07005314 public void setGlobalSetting(@NonNull ComponentName admin, String setting, String value) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01005315 throwIfParentInstance("setGlobalSetting");
Julia Reynoldsda551652014-05-14 17:15:16 -04005316 if (mService != null) {
5317 try {
5318 mService.setGlobalSetting(admin, setting, value);
5319 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07005320 throw e.rethrowFromSystemServer();
Julia Reynoldsda551652014-05-14 17:15:16 -04005321 }
5322 }
5323 }
5324
5325 /**
5326 * Called by profile or device owners to update {@link Settings.Secure} settings. Validation
5327 * that the value of the setting is in the correct form for the setting type should be performed
5328 * by the caller.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005329 * <p>
5330 * The settings that can be updated by a profile or device owner with this method are:
Julia Reynolds9ed66da2014-08-26 15:42:03 -04005331 * <ul>
5332 * <li>{@link Settings.Secure#DEFAULT_INPUT_METHOD}</li>
Amith Yamasani52c39a12014-10-21 11:14:04 -07005333 * <li>{@link Settings.Secure#INSTALL_NON_MARKET_APPS}</li>
Julia Reynolds9ed66da2014-08-26 15:42:03 -04005334 * <li>{@link Settings.Secure#SKIP_FIRST_USE_HINTS}</li>
5335 * </ul>
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005336 * <p>
5337 * A device owner can additionally update the following settings:
Julia Reynolds82735bc2014-09-04 16:43:30 -04005338 * <ul>
5339 * <li>{@link Settings.Secure#LOCATION_MODE}</li>
5340 * </ul>
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005341 *
Julia Reynoldsda551652014-05-14 17:15:16 -04005342 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
5343 * @param setting The name of the setting to update.
5344 * @param value The value to update the setting to.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005345 * @throws SecurityException if {@code admin} is not a device or profile owner.
Julia Reynoldsda551652014-05-14 17:15:16 -04005346 */
Robin Lee25e26452015-06-02 09:56:29 -07005347 public void setSecureSetting(@NonNull ComponentName admin, String setting, String value) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01005348 throwIfParentInstance("setSecureSetting");
Julia Reynoldsda551652014-05-14 17:15:16 -04005349 if (mService != null) {
5350 try {
5351 mService.setSecureSetting(admin, setting, value);
5352 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07005353 throw e.rethrowFromSystemServer();
Julia Reynoldsda551652014-05-14 17:15:16 -04005354 }
5355 }
5356 }
5357
Amith Yamasanif20d6402014-05-24 15:34:37 -07005358 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005359 * Designates a specific service component as the provider for making permission requests of a
5360 * local or remote administrator of the user.
Amith Yamasanif20d6402014-05-24 15:34:37 -07005361 * <p/>
5362 * Only a profile owner can designate the restrictions provider.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005363 *
Amith Yamasanif20d6402014-05-24 15:34:37 -07005364 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
Amith Yamasanif6e2fcc2014-07-10 13:41:55 -07005365 * @param provider The component name of the service that implements
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005366 * {@link RestrictionsReceiver}. If this param is null, it removes the restrictions
5367 * provider previously assigned.
5368 * @throws SecurityException if {@code admin} is not a device or profile owner.
Amith Yamasanif20d6402014-05-24 15:34:37 -07005369 */
Robin Lee25e26452015-06-02 09:56:29 -07005370 public void setRestrictionsProvider(@NonNull ComponentName admin,
5371 @Nullable ComponentName provider) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01005372 throwIfParentInstance("setRestrictionsProvider");
Amith Yamasanif20d6402014-05-24 15:34:37 -07005373 if (mService != null) {
5374 try {
Amith Yamasanif6e2fcc2014-07-10 13:41:55 -07005375 mService.setRestrictionsProvider(admin, provider);
Amith Yamasanif20d6402014-05-24 15:34:37 -07005376 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07005377 throw re.rethrowFromSystemServer();
Amith Yamasanif20d6402014-05-24 15:34:37 -07005378 }
5379 }
5380 }
Julia Reynolds4a21b252014-06-04 11:11:43 -04005381
5382 /**
5383 * Called by profile or device owners to set the master volume mute on or off.
5384 *
5385 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
5386 * @param on {@code true} to mute master volume, {@code false} to turn mute off.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005387 * @throws SecurityException if {@code admin} is not a device or profile owner.
Julia Reynolds4a21b252014-06-04 11:11:43 -04005388 */
Robin Lee25e26452015-06-02 09:56:29 -07005389 public void setMasterVolumeMuted(@NonNull ComponentName admin, boolean on) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01005390 throwIfParentInstance("setMasterVolumeMuted");
Julia Reynolds4a21b252014-06-04 11:11:43 -04005391 if (mService != null) {
5392 try {
5393 mService.setMasterVolumeMuted(admin, on);
5394 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07005395 throw re.rethrowFromSystemServer();
Julia Reynolds4a21b252014-06-04 11:11:43 -04005396 }
5397 }
5398 }
5399
5400 /**
5401 * Called by profile or device owners to check whether the master volume mute is on or off.
5402 *
5403 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
5404 * @return {@code true} if master volume is muted, {@code false} if it's not.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005405 * @throws SecurityException if {@code admin} is not a device or profile owner.
Julia Reynolds4a21b252014-06-04 11:11:43 -04005406 */
Robin Lee25e26452015-06-02 09:56:29 -07005407 public boolean isMasterVolumeMuted(@NonNull ComponentName admin) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01005408 throwIfParentInstance("isMasterVolumeMuted");
Julia Reynolds4a21b252014-06-04 11:11:43 -04005409 if (mService != null) {
5410 try {
5411 return mService.isMasterVolumeMuted(admin);
5412 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07005413 throw re.rethrowFromSystemServer();
Julia Reynolds4a21b252014-06-04 11:11:43 -04005414 }
5415 }
5416 return false;
5417 }
Kenny Guyc13053b2014-05-29 14:17:17 +01005418
5419 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005420 * Called by profile or device owners to change whether a user can uninstall a package.
Kenny Guyc13053b2014-05-29 14:17:17 +01005421 *
5422 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
5423 * @param packageName package to change.
Esteban Talaverad5c5c132014-08-20 11:35:57 +01005424 * @param uninstallBlocked true if the user shouldn't be able to uninstall the package.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005425 * @throws SecurityException if {@code admin} is not a device or profile owner.
Kenny Guyc13053b2014-05-29 14:17:17 +01005426 */
Robin Lee25e26452015-06-02 09:56:29 -07005427 public void setUninstallBlocked(@NonNull ComponentName admin, String packageName,
Esteban Talaverad5c5c132014-08-20 11:35:57 +01005428 boolean uninstallBlocked) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01005429 throwIfParentInstance("setUninstallBlocked");
Kenny Guyc13053b2014-05-29 14:17:17 +01005430 if (mService != null) {
5431 try {
Esteban Talaverad5c5c132014-08-20 11:35:57 +01005432 mService.setUninstallBlocked(admin, packageName, uninstallBlocked);
Kenny Guyc13053b2014-05-29 14:17:17 +01005433 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07005434 throw re.rethrowFromSystemServer();
Kenny Guyc13053b2014-05-29 14:17:17 +01005435 }
5436 }
5437 }
5438
5439 /**
Makoto Onuki32b30572015-12-11 14:29:51 -08005440 * Check whether the user has been blocked by device policy from uninstalling a package.
Rubin Xua97855b2014-11-07 05:41:00 +00005441 * Requires the caller to be the profile owner if checking a specific admin's policy.
Rubin Xue1e6faa2015-03-10 10:51:59 +00005442 * <p>
5443 * <strong>Note:</strong> Starting from {@link android.os.Build.VERSION_CODES#LOLLIPOP_MR1}, the
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005444 * behavior of this API is changed such that passing {@code null} as the {@code admin} parameter
5445 * will return if any admin has blocked the uninstallation. Before L MR1, passing {@code null}
5446 * will cause a NullPointerException to be raised.
Kenny Guyc13053b2014-05-29 14:17:17 +01005447 *
Robin Lee25e26452015-06-02 09:56:29 -07005448 * @param admin The name of the admin component whose blocking policy will be checked, or
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005449 * {@code null} to check whether any admin has blocked the uninstallation.
Kenny Guyc13053b2014-05-29 14:17:17 +01005450 * @param packageName package to check.
Rubin Xua97855b2014-11-07 05:41:00 +00005451 * @return true if uninstallation is blocked.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005452 * @throws SecurityException if {@code admin} is not a device or profile owner.
Kenny Guyc13053b2014-05-29 14:17:17 +01005453 */
Robin Lee25e26452015-06-02 09:56:29 -07005454 public boolean isUninstallBlocked(@Nullable ComponentName admin, String packageName) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01005455 throwIfParentInstance("isUninstallBlocked");
Kenny Guyc13053b2014-05-29 14:17:17 +01005456 if (mService != null) {
5457 try {
Esteban Talavera729b2a62014-08-27 18:01:58 +01005458 return mService.isUninstallBlocked(admin, packageName);
Kenny Guyc13053b2014-05-29 14:17:17 +01005459 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07005460 throw re.rethrowFromSystemServer();
Kenny Guyc13053b2014-05-29 14:17:17 +01005461 }
5462 }
5463 return false;
5464 }
Svetoslav976e8bd2014-07-16 15:12:03 -07005465
5466 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005467 * Called by the profile owner of a managed profile to enable widget providers from a given
5468 * package to be available in the parent profile. As a result the user will be able to add
5469 * widgets from the white-listed package running under the profile to a widget host which runs
5470 * under the parent profile, for example the home screen. Note that a package may have zero or
5471 * more provider components, where each component provides a different widget type.
Svetoslav976e8bd2014-07-16 15:12:03 -07005472 * <p>
5473 * <strong>Note:</strong> By default no widget provider package is white-listed.
Svetoslav976e8bd2014-07-16 15:12:03 -07005474 *
5475 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
5476 * @param packageName The package from which widget providers are white-listed.
5477 * @return Whether the package was added.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005478 * @throws SecurityException if {@code admin} is not a profile owner.
Svetoslav976e8bd2014-07-16 15:12:03 -07005479 * @see #removeCrossProfileWidgetProvider(android.content.ComponentName, String)
5480 * @see #getCrossProfileWidgetProviders(android.content.ComponentName)
5481 */
Robin Lee25e26452015-06-02 09:56:29 -07005482 public boolean addCrossProfileWidgetProvider(@NonNull ComponentName admin, String packageName) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01005483 throwIfParentInstance("addCrossProfileWidgetProvider");
Svetoslav976e8bd2014-07-16 15:12:03 -07005484 if (mService != null) {
5485 try {
5486 return mService.addCrossProfileWidgetProvider(admin, packageName);
5487 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07005488 throw re.rethrowFromSystemServer();
Svetoslav976e8bd2014-07-16 15:12:03 -07005489 }
5490 }
5491 return false;
5492 }
5493
5494 /**
Amith Yamasanic34dc7c2014-09-18 09:42:42 -07005495 * Called by the profile owner of a managed profile to disable widget providers from a given
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005496 * package to be available in the parent profile. For this method to take effect the package
5497 * should have been added via
5498 * {@link #addCrossProfileWidgetProvider( android.content.ComponentName, String)}.
Svetoslav976e8bd2014-07-16 15:12:03 -07005499 * <p>
5500 * <strong>Note:</strong> By default no widget provider package is white-listed.
Svetoslav976e8bd2014-07-16 15:12:03 -07005501 *
5502 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005503 * @param packageName The package from which widget providers are no longer white-listed.
Svetoslav976e8bd2014-07-16 15:12:03 -07005504 * @return Whether the package was removed.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005505 * @throws SecurityException if {@code admin} is not a profile owner.
Svetoslav976e8bd2014-07-16 15:12:03 -07005506 * @see #addCrossProfileWidgetProvider(android.content.ComponentName, String)
5507 * @see #getCrossProfileWidgetProviders(android.content.ComponentName)
5508 */
Esteban Talavera62399912016-01-11 15:37:55 +00005509 public boolean removeCrossProfileWidgetProvider(
5510 @NonNull ComponentName admin, String packageName) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01005511 throwIfParentInstance("removeCrossProfileWidgetProvider");
Svetoslav976e8bd2014-07-16 15:12:03 -07005512 if (mService != null) {
5513 try {
5514 return mService.removeCrossProfileWidgetProvider(admin, packageName);
5515 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07005516 throw re.rethrowFromSystemServer();
Svetoslav976e8bd2014-07-16 15:12:03 -07005517 }
5518 }
5519 return false;
5520 }
5521
5522 /**
Amith Yamasanic34dc7c2014-09-18 09:42:42 -07005523 * Called by the profile owner of a managed profile to query providers from which packages are
Svetoslav976e8bd2014-07-16 15:12:03 -07005524 * available in the parent profile.
5525 *
5526 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
5527 * @return The white-listed package list.
Svetoslav976e8bd2014-07-16 15:12:03 -07005528 * @see #addCrossProfileWidgetProvider(android.content.ComponentName, String)
5529 * @see #removeCrossProfileWidgetProvider(android.content.ComponentName, String)
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005530 * @throws SecurityException if {@code admin} is not a profile owner.
Svetoslav976e8bd2014-07-16 15:12:03 -07005531 */
Robin Lee25e26452015-06-02 09:56:29 -07005532 public List<String> getCrossProfileWidgetProviders(@NonNull ComponentName admin) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01005533 throwIfParentInstance("getCrossProfileWidgetProviders");
Svetoslav976e8bd2014-07-16 15:12:03 -07005534 if (mService != null) {
5535 try {
5536 List<String> providers = mService.getCrossProfileWidgetProviders(admin);
5537 if (providers != null) {
5538 return providers;
5539 }
5540 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07005541 throw re.rethrowFromSystemServer();
Svetoslav976e8bd2014-07-16 15:12:03 -07005542 }
5543 }
5544 return Collections.emptyList();
5545 }
Julia Reynoldsfca04ca2015-02-17 13:39:12 -05005546
5547 /**
Makoto Onuki32b30572015-12-11 14:29:51 -08005548 * Called by profile or device owners to set the user's photo.
Julia Reynoldsfca04ca2015-02-17 13:39:12 -05005549 *
5550 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
5551 * @param icon the bitmap to set as the photo.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005552 * @throws SecurityException if {@code admin} is not a device or profile owner.
Julia Reynoldsfca04ca2015-02-17 13:39:12 -05005553 */
Robin Lee25e26452015-06-02 09:56:29 -07005554 public void setUserIcon(@NonNull ComponentName admin, Bitmap icon) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01005555 throwIfParentInstance("setUserIcon");
Julia Reynoldsfca04ca2015-02-17 13:39:12 -05005556 try {
5557 mService.setUserIcon(admin, icon);
5558 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07005559 throw re.rethrowFromSystemServer();
Julia Reynoldsfca04ca2015-02-17 13:39:12 -05005560 }
5561 }
Craig Lafayettedbe31a62015-04-02 13:14:39 -04005562
5563 /**
Rubin Xu5faad8e2015-04-20 17:43:48 +01005564 * Called by device owners to set a local system update policy. When a new policy is set,
5565 * {@link #ACTION_SYSTEM_UPDATE_POLICY_CHANGED} is broadcasted.
Rubin Xu8027a4f2015-03-10 17:52:37 +00005566 *
Robin Lee25e26452015-06-02 09:56:29 -07005567 * @param admin Which {@link DeviceAdminReceiver} this request is associated with. All
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005568 * components in the device owner package can set system update policies and the most
5569 * recent policy takes effect.
Robin Lee25e26452015-06-02 09:56:29 -07005570 * @param policy the new policy, or {@code null} to clear the current policy.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005571 * @throws SecurityException if {@code admin} is not a device owner.
Rubin Xu5faad8e2015-04-20 17:43:48 +01005572 * @see SystemUpdatePolicy
Rubin Xu8027a4f2015-03-10 17:52:37 +00005573 */
Robin Lee25e26452015-06-02 09:56:29 -07005574 public void setSystemUpdatePolicy(@NonNull ComponentName admin, SystemUpdatePolicy policy) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01005575 throwIfParentInstance("setSystemUpdatePolicy");
Rubin Xu8027a4f2015-03-10 17:52:37 +00005576 if (mService != null) {
5577 try {
Robin Lee25e26452015-06-02 09:56:29 -07005578 mService.setSystemUpdatePolicy(admin, policy);
Rubin Xu8027a4f2015-03-10 17:52:37 +00005579 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07005580 throw re.rethrowFromSystemServer();
Rubin Xu8027a4f2015-03-10 17:52:37 +00005581 }
5582 }
5583 }
5584
5585 /**
Rubin Xu5faad8e2015-04-20 17:43:48 +01005586 * Retrieve a local system update policy set previously by {@link #setSystemUpdatePolicy}.
Rubin Xu8027a4f2015-03-10 17:52:37 +00005587 *
Robin Lee25e26452015-06-02 09:56:29 -07005588 * @return The current policy object, or {@code null} if no policy is set.
Rubin Xu8027a4f2015-03-10 17:52:37 +00005589 */
Rubin Xu5faad8e2015-04-20 17:43:48 +01005590 public SystemUpdatePolicy getSystemUpdatePolicy() {
Benjamin Franzbc33c822016-04-15 08:57:52 +01005591 throwIfParentInstance("getSystemUpdatePolicy");
Rubin Xu8027a4f2015-03-10 17:52:37 +00005592 if (mService != null) {
5593 try {
Rubin Xud86d58c2015-05-05 16:57:37 +01005594 return mService.getSystemUpdatePolicy();
Rubin Xu8027a4f2015-03-10 17:52:37 +00005595 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07005596 throw re.rethrowFromSystemServer();
Rubin Xu8027a4f2015-03-10 17:52:37 +00005597 }
5598 }
5599 return null;
5600 }
Benjamin Franze36087e2015-04-07 16:40:34 +01005601
5602 /**
5603 * Called by a device owner to disable the keyguard altogether.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005604 * <p>
5605 * Setting the keyguard to disabled has the same effect as choosing "None" as the screen lock
5606 * type. However, this call has no effect if a password, pin or pattern is currently set. If a
5607 * password, pin or pattern is set after the keyguard was disabled, the keyguard stops being
5608 * disabled.
Benjamin Franze36087e2015-04-07 16:40:34 +01005609 *
5610 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
Benjamin Franzbece8062015-05-06 12:14:31 +01005611 * @param disabled {@code true} disables the keyguard, {@code false} reenables it.
Benjamin Franze36087e2015-04-07 16:40:34 +01005612 * @return {@code false} if attempting to disable the keyguard while a lock password was in
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005613 * place. {@code true} otherwise.
5614 * @throws SecurityException if {@code admin} is not a device owner.
Benjamin Franze36087e2015-04-07 16:40:34 +01005615 */
Robin Lee25e26452015-06-02 09:56:29 -07005616 public boolean setKeyguardDisabled(@NonNull ComponentName admin, boolean disabled) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01005617 throwIfParentInstance("setKeyguardDisabled");
Benjamin Franze36087e2015-04-07 16:40:34 +01005618 try {
Benjamin Franzbece8062015-05-06 12:14:31 +01005619 return mService.setKeyguardDisabled(admin, disabled);
Benjamin Franze36087e2015-04-07 16:40:34 +01005620 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07005621 throw re.rethrowFromSystemServer();
Benjamin Franze36087e2015-04-07 16:40:34 +01005622 }
5623 }
Benjamin Franzea2ec972015-03-16 17:18:09 +00005624
5625 /**
Benjamin Franzbece8062015-05-06 12:14:31 +01005626 * Called by device owner to disable the status bar. Disabling the status bar blocks
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005627 * notifications, quick settings and other screen overlays that allow escaping from a single use
5628 * device.
Benjamin Franzea2ec972015-03-16 17:18:09 +00005629 *
5630 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
Benjamin Franzbece8062015-05-06 12:14:31 +01005631 * @param disabled {@code true} disables the status bar, {@code false} reenables it.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005632 * @return {@code false} if attempting to disable the status bar failed. {@code true} otherwise.
5633 * @throws SecurityException if {@code admin} is not a device owner.
Benjamin Franzea2ec972015-03-16 17:18:09 +00005634 */
Robin Lee25e26452015-06-02 09:56:29 -07005635 public boolean setStatusBarDisabled(@NonNull ComponentName admin, boolean disabled) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01005636 throwIfParentInstance("setStatusBarDisabled");
Benjamin Franzea2ec972015-03-16 17:18:09 +00005637 try {
Benjamin Franzbece8062015-05-06 12:14:31 +01005638 return mService.setStatusBarDisabled(admin, disabled);
Benjamin Franzea2ec972015-03-16 17:18:09 +00005639 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07005640 throw re.rethrowFromSystemServer();
Benjamin Franzea2ec972015-03-16 17:18:09 +00005641 }
5642 }
Rubin Xudc105cc2015-04-14 23:38:01 +01005643
5644 /**
5645 * Callable by the system update service to notify device owners about pending updates.
5646 * The caller must hold {@link android.Manifest.permission#NOTIFY_PENDING_SYSTEM_UPDATE}
5647 * permission.
5648 *
5649 * @param updateReceivedTime The time as given by {@link System#currentTimeMillis()} indicating
5650 * when the current pending update was first available. -1 if no update is available.
5651 * @hide
5652 */
5653 @SystemApi
5654 public void notifyPendingSystemUpdate(long updateReceivedTime) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01005655 throwIfParentInstance("notifyPendingSystemUpdate");
Rubin Xudc105cc2015-04-14 23:38:01 +01005656 if (mService != null) {
5657 try {
5658 mService.notifyPendingSystemUpdate(updateReceivedTime);
5659 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07005660 throw re.rethrowFromSystemServer();
Rubin Xudc105cc2015-04-14 23:38:01 +01005661 }
5662 }
5663 }
Julia Reynolds13c58ba2015-04-20 16:42:54 -04005664
5665 /**
Amith Yamasanid49489b2015-04-28 14:00:26 -07005666 * Called by profile or device owners to set the default response for future runtime permission
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005667 * requests by applications. The policy can allow for normal operation which prompts the user to
5668 * grant a permission, or can allow automatic granting or denying of runtime permission requests
5669 * by an application. This also applies to new permissions declared by app updates. When a
5670 * permission is denied or granted this way, the effect is equivalent to setting the permission
5671 * grant state via {@link #setPermissionGrantState}.
5672 * <p/>
5673 * As this policy only acts on runtime permission requests, it only applies to applications
Dianne Hackborn0e3de6c2015-07-29 15:20:21 -07005674 * built with a {@code targetSdkVersion} of {@link android.os.Build.VERSION_CODES#M} or later.
Benjamin Franz45dd6662015-07-08 14:24:14 +01005675 *
Amith Yamasanid49489b2015-04-28 14:00:26 -07005676 * @param admin Which profile or device owner this request is associated with.
5677 * @param policy One of the policy constants {@link #PERMISSION_POLICY_PROMPT},
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005678 * {@link #PERMISSION_POLICY_AUTO_GRANT} and {@link #PERMISSION_POLICY_AUTO_DENY}.
5679 * @throws SecurityException if {@code admin} is not a device or profile owner.
Benjamin Franz45dd6662015-07-08 14:24:14 +01005680 * @see #setPermissionGrantState
Amith Yamasanid49489b2015-04-28 14:00:26 -07005681 */
Robin Lee25e26452015-06-02 09:56:29 -07005682 public void setPermissionPolicy(@NonNull ComponentName admin, int policy) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01005683 throwIfParentInstance("setPermissionPolicy");
Amith Yamasanid49489b2015-04-28 14:00:26 -07005684 try {
5685 mService.setPermissionPolicy(admin, policy);
5686 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07005687 throw re.rethrowFromSystemServer();
Amith Yamasanid49489b2015-04-28 14:00:26 -07005688 }
5689 }
5690
5691 /**
5692 * Returns the current runtime permission policy set by the device or profile owner. The
5693 * default is {@link #PERMISSION_POLICY_PROMPT}.
5694 * @param admin Which profile or device owner this request is associated with.
5695 * @return the current policy for future permission requests.
5696 */
Esteban Talavera28b95702015-06-24 15:23:42 +01005697 public int getPermissionPolicy(ComponentName admin) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01005698 throwIfParentInstance("getPermissionPolicy");
Amith Yamasanid49489b2015-04-28 14:00:26 -07005699 try {
5700 return mService.getPermissionPolicy(admin);
5701 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07005702 throw re.rethrowFromSystemServer();
Amith Yamasanid49489b2015-04-28 14:00:26 -07005703 }
5704 }
5705
5706 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005707 * Sets the grant state of a runtime permission for a specific application. The state can be
5708 * {@link #PERMISSION_GRANT_STATE_DEFAULT default} in which a user can manage it through the UI,
5709 * {@link #PERMISSION_GRANT_STATE_DENIED denied}, in which the permission is denied and the user
5710 * cannot manage it through the UI, and {@link #PERMISSION_GRANT_STATE_GRANTED granted} in which
5711 * the permission is granted and the user cannot manage it through the UI. This might affect all
5712 * permissions in a group that the runtime permission belongs to. This method can only be called
Svet Ganovd8ecc5a2015-05-20 10:45:43 -07005713 * by a profile or device owner.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005714 * <p/>
5715 * Setting the grant state to {@link #PERMISSION_GRANT_STATE_DEFAULT default} does not revoke
5716 * the permission. It retains the previous grant, if any.
5717 * <p/>
5718 * Permissions can be granted or revoked only for applications built with a
Dianne Hackborn0e3de6c2015-07-29 15:20:21 -07005719 * {@code targetSdkVersion} of {@link android.os.Build.VERSION_CODES#M} or later.
Amith Yamasani0bf8f7c2015-06-22 13:00:32 -07005720 *
Amith Yamasanid49489b2015-04-28 14:00:26 -07005721 * @param admin Which profile or device owner this request is associated with.
5722 * @param packageName The application to grant or revoke a permission to.
5723 * @param permission The permission to grant or revoke.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005724 * @param grantState The permission grant state which is one of
5725 * {@link #PERMISSION_GRANT_STATE_DENIED}, {@link #PERMISSION_GRANT_STATE_DEFAULT},
5726 * {@link #PERMISSION_GRANT_STATE_GRANTED},
Svet Ganovd8ecc5a2015-05-20 10:45:43 -07005727 * @return whether the permission was successfully granted or revoked.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005728 * @throws SecurityException if {@code admin} is not a device or profile owner.
Svet Ganovd8ecc5a2015-05-20 10:45:43 -07005729 * @see #PERMISSION_GRANT_STATE_DENIED
5730 * @see #PERMISSION_GRANT_STATE_DEFAULT
5731 * @see #PERMISSION_GRANT_STATE_GRANTED
Amith Yamasanid49489b2015-04-28 14:00:26 -07005732 */
Robin Lee25e26452015-06-02 09:56:29 -07005733 public boolean setPermissionGrantState(@NonNull ComponentName admin, String packageName,
Svet Ganovd8ecc5a2015-05-20 10:45:43 -07005734 String permission, int grantState) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01005735 throwIfParentInstance("setPermissionGrantState");
Amith Yamasanid49489b2015-04-28 14:00:26 -07005736 try {
Svet Ganovd8ecc5a2015-05-20 10:45:43 -07005737 return mService.setPermissionGrantState(admin, packageName, permission, grantState);
Amith Yamasanid49489b2015-04-28 14:00:26 -07005738 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07005739 throw re.rethrowFromSystemServer();
Amith Yamasanid49489b2015-04-28 14:00:26 -07005740 }
5741 }
Amith Yamasani184b3752015-05-22 13:00:51 -07005742
5743 /**
5744 * Returns the current grant state of a runtime permission for a specific application.
5745 *
5746 * @param admin Which profile or device owner this request is associated with.
5747 * @param packageName The application to check the grant state for.
5748 * @param permission The permission to check for.
5749 * @return the current grant state specified by device policy. If the profile or device owner
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005750 * has not set a grant state, the return value is
5751 * {@link #PERMISSION_GRANT_STATE_DEFAULT}. This does not indicate whether or not the
5752 * permission is currently granted for the package.
5753 * <p/>
5754 * If a grant state was set by the profile or device owner, then the return value will
5755 * be one of {@link #PERMISSION_GRANT_STATE_DENIED} or
5756 * {@link #PERMISSION_GRANT_STATE_GRANTED}, which indicates if the permission is
5757 * currently denied or granted.
5758 * @throws SecurityException if {@code admin} is not a device or profile owner.
Amith Yamasani184b3752015-05-22 13:00:51 -07005759 * @see #setPermissionGrantState(ComponentName, String, String, int)
5760 * @see PackageManager#checkPermission(String, String)
5761 */
Robin Lee25e26452015-06-02 09:56:29 -07005762 public int getPermissionGrantState(@NonNull ComponentName admin, String packageName,
Amith Yamasani184b3752015-05-22 13:00:51 -07005763 String permission) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01005764 throwIfParentInstance("getPermissionGrantState");
Amith Yamasani184b3752015-05-22 13:00:51 -07005765 try {
5766 return mService.getPermissionGrantState(admin, packageName, permission);
5767 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07005768 throw re.rethrowFromSystemServer();
Amith Yamasani184b3752015-05-22 13:00:51 -07005769 }
5770 }
Nicolas Prevot07387fe2015-10-30 17:53:30 +00005771
5772 /**
5773 * Returns if provisioning a managed profile or device is possible or not.
5774 * @param action One of {@link #ACTION_PROVISION_MANAGED_DEVICE},
5775 * {@link #ACTION_PROVISION_MANAGED_PROFILE}.
Nicolas Prevot07387fe2015-10-30 17:53:30 +00005776 * @return if provisioning a managed profile or device is possible or not.
5777 * @throws IllegalArgumentException if the supplied action is not valid.
5778 */
5779 public boolean isProvisioningAllowed(String action) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01005780 throwIfParentInstance("isProvisioningAllowed");
Nicolas Prevot07387fe2015-10-30 17:53:30 +00005781 try {
5782 return mService.isProvisioningAllowed(action);
5783 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07005784 throw re.rethrowFromSystemServer();
Nicolas Prevot07387fe2015-10-30 17:53:30 +00005785 }
5786 }
Mahaver Chopra15a46b02015-11-11 14:54:35 +00005787
5788 /**
Mahaver Chopra15a46b02015-11-11 14:54:35 +00005789 * Return if this user is a managed profile of another user. An admin can become the profile
5790 * owner of a managed profile with {@link #ACTION_PROVISION_MANAGED_PROFILE} and of a managed
Kenny Guyffa38402016-03-31 16:40:57 +01005791 * user with {@link #createAndManageUser}
Mahaver Chopra15a46b02015-11-11 14:54:35 +00005792 * @param admin Which profile owner this request is associated with.
5793 * @return if this user is a managed profile of another user.
5794 */
5795 public boolean isManagedProfile(@NonNull ComponentName admin) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01005796 throwIfParentInstance("isManagedProfile");
Mahaver Chopra15a46b02015-11-11 14:54:35 +00005797 try {
5798 return mService.isManagedProfile(admin);
5799 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07005800 throw re.rethrowFromSystemServer();
Mahaver Chopra15a46b02015-11-11 14:54:35 +00005801 }
5802 }
5803
5804 /**
5805 * @hide
5806 * Return if this user is a system-only user. An admin can manage a device from a system only
5807 * user by calling {@link #ACTION_PROVISION_MANAGED_SHAREABLE_DEVICE}.
5808 * @param admin Which device owner this request is associated with.
5809 * @return if this user is a system-only user.
5810 */
5811 public boolean isSystemOnlyUser(@NonNull ComponentName admin) {
5812 try {
5813 return mService.isSystemOnlyUser(admin);
5814 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07005815 throw re.rethrowFromSystemServer();
Mahaver Chopra15a46b02015-11-11 14:54:35 +00005816 }
5817 }
Makoto Onukia31ebbc2015-11-23 17:15:21 -08005818
5819 /**
5820 * Called by device owner to get the MAC address of the Wi-Fi device.
5821 *
Sudheer Shanka3cb4da12016-03-07 18:51:49 -08005822 * @param admin Which device owner this request is associated with.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005823 * @return the MAC address of the Wi-Fi device, or null when the information is not available.
5824 * (For example, Wi-Fi hasn't been enabled, or the device doesn't support Wi-Fi.)
5825 * <p>
5826 * The address will be in the {@code XX:XX:XX:XX:XX:XX} format.
5827 * @throws SecurityException if {@code admin} is not a device owner.
Makoto Onukia31ebbc2015-11-23 17:15:21 -08005828 */
Sudheer Shanka3cb4da12016-03-07 18:51:49 -08005829 public String getWifiMacAddress(@NonNull ComponentName admin) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01005830 throwIfParentInstance("getWifiMacAddress");
Makoto Onukia31ebbc2015-11-23 17:15:21 -08005831 try {
Sudheer Shanka3cb4da12016-03-07 18:51:49 -08005832 return mService.getWifiMacAddress(admin);
Makoto Onukia31ebbc2015-11-23 17:15:21 -08005833 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07005834 throw re.rethrowFromSystemServer();
Makoto Onukia31ebbc2015-11-23 17:15:21 -08005835 }
5836 }
Mahaver Chopra1ce53bc2015-12-14 13:35:14 +00005837
5838 /**
Mahaver Chopra1216ae52016-03-11 15:39:48 +00005839 * Called by device owner to reboot the device. If there is an ongoing call on the device,
5840 * throws an {@link IllegalStateException}.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005841 * @param admin Which device owner the request is associated with.
Mahaver Chopra1216ae52016-03-11 15:39:48 +00005842 * @throws IllegalStateException if device has an ongoing call.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005843 * @throws SecurityException if {@code admin} is not a device owner.
Mahaver Chopra1216ae52016-03-11 15:39:48 +00005844 * @see TelephonyManager#CALL_STATE_IDLE
Mahaver Chopra1ce53bc2015-12-14 13:35:14 +00005845 */
5846 public void reboot(@NonNull ComponentName admin) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01005847 throwIfParentInstance("reboot");
Mahaver Chopra1ce53bc2015-12-14 13:35:14 +00005848 try {
5849 mService.reboot(admin);
5850 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07005851 throw re.rethrowFromSystemServer();
Mahaver Chopra1ce53bc2015-12-14 13:35:14 +00005852 }
5853 }
Kenny Guy06de4e72015-12-22 12:07:39 +00005854
5855 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005856 * Called by a device admin to set the short support message. This will be displayed to the user
5857 * in settings screens where funtionality has been disabled by the admin. The message should be
5858 * limited to a short statement such as "This setting is disabled by your administrator. Contact
5859 * someone@example.com for support." If the message is longer than 200 characters it may be
5860 * truncated.
5861 * <p>
5862 * If the short support message needs to be localized, it is the responsibility of the
Benjamin Franz3e8a7092016-01-25 16:19:08 +00005863 * {@link DeviceAdminReceiver} to listen to the {@link Intent#ACTION_LOCALE_CHANGED} broadcast
5864 * and set a new version of this string accordingly.
5865 *
Kenny Guy06de4e72015-12-22 12:07:39 +00005866 * @see #setLongSupportMessage
Kenny Guy06de4e72015-12-22 12:07:39 +00005867 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005868 * @param message Short message to be displayed to the user in settings or null to clear the
5869 * existing message.
5870 * @throws SecurityException if {@code admin} is not an active administrator.
Kenny Guy06de4e72015-12-22 12:07:39 +00005871 */
5872 public void setShortSupportMessage(@NonNull ComponentName admin,
Sudheer Shanka3ccca91e2016-04-11 21:36:17 -07005873 @Nullable CharSequence message) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01005874 throwIfParentInstance("setShortSupportMessage");
Kenny Guy06de4e72015-12-22 12:07:39 +00005875 if (mService != null) {
5876 try {
5877 mService.setShortSupportMessage(admin, message);
5878 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07005879 throw e.rethrowFromSystemServer();
Kenny Guy06de4e72015-12-22 12:07:39 +00005880 }
5881 }
5882 }
5883
5884 /**
5885 * Called by a device admin to get the short support message.
5886 *
5887 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
Sudheer Shanka3ccca91e2016-04-11 21:36:17 -07005888 * @return The message set by {@link #setShortSupportMessage(ComponentName, CharSequence)} or
5889 * null if no message has been set.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005890 * @throws SecurityException if {@code admin} is not an active administrator.
Kenny Guy06de4e72015-12-22 12:07:39 +00005891 */
Sudheer Shanka3ccca91e2016-04-11 21:36:17 -07005892 public CharSequence getShortSupportMessage(@NonNull ComponentName admin) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01005893 throwIfParentInstance("getShortSupportMessage");
Kenny Guy06de4e72015-12-22 12:07:39 +00005894 if (mService != null) {
5895 try {
5896 return mService.getShortSupportMessage(admin);
5897 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07005898 throw e.rethrowFromSystemServer();
Kenny Guy06de4e72015-12-22 12:07:39 +00005899 }
5900 }
5901 return null;
5902 }
5903
5904 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005905 * Called by a device admin to set the long support message. This will be displayed to the user
5906 * in the device administators settings screen.
5907 * <p>
5908 * If the long support message needs to be localized, it is the responsibility of the
Benjamin Franz3e8a7092016-01-25 16:19:08 +00005909 * {@link DeviceAdminReceiver} to listen to the {@link Intent#ACTION_LOCALE_CHANGED} broadcast
5910 * and set a new version of this string accordingly.
5911 *
Kenny Guy06de4e72015-12-22 12:07:39 +00005912 * @see #setShortSupportMessage
Kenny Guy06de4e72015-12-22 12:07:39 +00005913 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005914 * @param message Long message to be displayed to the user in settings or null to clear the
5915 * existing message.
5916 * @throws SecurityException if {@code admin} is not an active administrator.
Kenny Guy06de4e72015-12-22 12:07:39 +00005917 */
5918 public void setLongSupportMessage(@NonNull ComponentName admin,
Sudheer Shanka3ccca91e2016-04-11 21:36:17 -07005919 @Nullable CharSequence message) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01005920 throwIfParentInstance("setLongSupportMessage");
Kenny Guy06de4e72015-12-22 12:07:39 +00005921 if (mService != null) {
5922 try {
5923 mService.setLongSupportMessage(admin, message);
5924 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07005925 throw e.rethrowFromSystemServer();
Kenny Guy06de4e72015-12-22 12:07:39 +00005926 }
5927 }
5928 }
5929
5930 /**
5931 * Called by a device admin to get the long support message.
5932 *
5933 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
Sudheer Shanka3ccca91e2016-04-11 21:36:17 -07005934 * @return The message set by {@link #setLongSupportMessage(ComponentName, CharSequence)} or
5935 * null if no message has been set.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005936 * @throws SecurityException if {@code admin} is not an active administrator.
Kenny Guy06de4e72015-12-22 12:07:39 +00005937 */
Sudheer Shanka3ccca91e2016-04-11 21:36:17 -07005938 public CharSequence getLongSupportMessage(@NonNull ComponentName admin) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01005939 throwIfParentInstance("getLongSupportMessage");
Kenny Guy06de4e72015-12-22 12:07:39 +00005940 if (mService != null) {
5941 try {
5942 return mService.getLongSupportMessage(admin);
5943 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07005944 throw e.rethrowFromSystemServer();
Kenny Guy06de4e72015-12-22 12:07:39 +00005945 }
5946 }
5947 return null;
5948 }
5949
5950 /**
5951 * Called by the system to get the short support message.
5952 *
5953 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
5954 * @param userHandle user id the admin is running as.
Sudheer Shanka3ccca91e2016-04-11 21:36:17 -07005955 * @return The message set by {@link #setShortSupportMessage(ComponentName, CharSequence)}
Kenny Guy06de4e72015-12-22 12:07:39 +00005956 *
5957 * @hide
5958 */
Sudheer Shanka3ccca91e2016-04-11 21:36:17 -07005959 public CharSequence getShortSupportMessageForUser(@NonNull ComponentName admin,
5960 int userHandle) {
Kenny Guy06de4e72015-12-22 12:07:39 +00005961 if (mService != null) {
5962 try {
5963 return mService.getShortSupportMessageForUser(admin, userHandle);
5964 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07005965 throw e.rethrowFromSystemServer();
Kenny Guy06de4e72015-12-22 12:07:39 +00005966 }
5967 }
5968 return null;
5969 }
5970
5971
5972 /**
5973 * Called by the system to get the long support message.
5974 *
5975 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
5976 * @param userHandle user id the admin is running as.
Sudheer Shanka3ccca91e2016-04-11 21:36:17 -07005977 * @return The message set by {@link #setLongSupportMessage(ComponentName, CharSequence)}
Kenny Guy06de4e72015-12-22 12:07:39 +00005978 *
5979 * @hide
5980 */
Sudheer Shanka3ccca91e2016-04-11 21:36:17 -07005981 public CharSequence getLongSupportMessageForUser(@NonNull ComponentName admin, int userHandle) {
Kenny Guy06de4e72015-12-22 12:07:39 +00005982 if (mService != null) {
5983 try {
5984 return mService.getLongSupportMessageForUser(admin, userHandle);
5985 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07005986 throw e.rethrowFromSystemServer();
Kenny Guy06de4e72015-12-22 12:07:39 +00005987 }
5988 }
5989 return null;
5990 }
Clara Bayarri3e826ef2015-12-14 17:51:22 +00005991
5992 /**
Esteban Talavera62399912016-01-11 15:37:55 +00005993 * Called by the profile owner of a managed profile to obtain a {@link DevicePolicyManager}
5994 * whose calls act on the parent profile.
Benjamin Franz66b45f02016-04-05 19:12:39 +01005995 *
5996 * <p>The following methods are supported for the parent instance, all other methods will
5997 * throw a SecurityException when called on the parent instance:
5998 * <ul>
5999 * <li>{@link #getPasswordQuality}</li>
6000 * <li>{@link #setPasswordQuality}</li>
6001 * <li>{@link #getPasswordMinimumLength}</li>
6002 * <li>{@link #setPasswordMinimumLength}</li>
6003 * <li>{@link #getPasswordMinimumUpperCase}</li>
6004 * <li>{@link #setPasswordMinimumUpperCase}</li>
6005 * <li>{@link #getPasswordMinimumLowerCase}</li>
6006 * <li>{@link #setPasswordMinimumLowerCase}</li>
6007 * <li>{@link #getPasswordMinimumLetters}</li>
6008 * <li>{@link #setPasswordMinimumLetters}</li>
6009 * <li>{@link #getPasswordMinimumNumeric}</li>
6010 * <li>{@link #setPasswordMinimumNumeric}</li>
6011 * <li>{@link #getPasswordMinimumSymbols}</li>
6012 * <li>{@link #setPasswordMinimumSymbols}</li>
6013 * <li>{@link #getPasswordMinimumNonLetter}</li>
6014 * <li>{@link #setPasswordMinimumNonLetter}</li>
6015 * <li>{@link #getPasswordHistoryLength}</li>
6016 * <li>{@link #setPasswordHistoryLength}</li>
6017 * <li>{@link #getPasswordExpirationTimeout}</li>
6018 * <li>{@link #setPasswordExpirationTimeout}</li>
6019 * <li>{@link #getPasswordExpiration}</li>
6020 * <li>{@link #isActivePasswordSufficient}</li>
6021 * <li>{@link #getCurrentFailedPasswordAttempts}</li>
6022 * <li>{@link #getMaximumFailedPasswordsForWipe}</li>
6023 * <li>{@link #setMaximumFailedPasswordsForWipe}</li>
6024 * <li>{@link #getMaximumTimeToLock}</li>
6025 * <li>{@link #setMaximumTimeToLock}</li>
6026 * <li>{@link #lockNow}</li>
6027 * <li>{@link #getKeyguardDisabledFeatures}</li>
6028 * <li>{@link #setKeyguardDisabledFeatures}</li>
6029 * <li>{@link #getTrustAgentConfiguration}</li>
6030 * <li>{@link #setTrustAgentConfiguration}</li>
6031 * </ul>
Clara Bayarri3e826ef2015-12-14 17:51:22 +00006032 *
6033 * @return a new instance of {@link DevicePolicyManager} that acts on the parent profile.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07006034 * @throws SecurityException if {@code admin} is not a profile owner.
Clara Bayarri3e826ef2015-12-14 17:51:22 +00006035 */
6036 public DevicePolicyManager getParentProfileInstance(@NonNull ComponentName admin) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01006037 throwIfParentInstance("getParentProfileInstance");
Clara Bayarri3e826ef2015-12-14 17:51:22 +00006038 try {
6039 if (!mService.isManagedProfile(admin)) {
6040 throw new SecurityException("The current user does not have a parent profile.");
6041 }
6042 return new DevicePolicyManager(mContext, true);
Rubin Xuc3cd05f2016-01-11 12:11:35 +00006043 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07006044 throw e.rethrowFromSystemServer();
Rubin Xuc3cd05f2016-01-11 12:11:35 +00006045 }
6046 }
6047
6048 /**
Michal Karpinski6235a942016-03-15 12:07:23 +00006049 * Called by device owner to control the security logging feature. Logging can only be
6050 * enabled on single user devices where the sole user is managed by the device owner.
6051 *
6052 * <p> Security logs contain various information intended for security auditing purposes.
6053 * See {@link SecurityEvent} for details.
6054 *
6055 * <p>There must be only one user on the device, managed by the device owner.
6056 * Otherwise a {@link SecurityException} will be thrown.
Michal Karpinskib58e4962016-03-01 14:55:10 +00006057 *
Rubin Xuc3cd05f2016-01-11 12:11:35 +00006058 * @param admin Which device owner this request is associated with.
Michal Karpinski6235a942016-03-15 12:07:23 +00006059 * @param enabled whether security logging should be enabled or not.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07006060 * @throws SecurityException if {@code admin} is not a device owner.
Michal Karpinski6235a942016-03-15 12:07:23 +00006061 * @see #retrieveSecurityLogs
6062 */
6063 public void setSecurityLoggingEnabled(@NonNull ComponentName admin, boolean enabled) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01006064 throwIfParentInstance("setSecurityLoggingEnabled");
Michal Karpinski6235a942016-03-15 12:07:23 +00006065 try {
6066 mService.setSecurityLoggingEnabled(admin, enabled);
6067 } catch (RemoteException re) {
6068 throw re.rethrowFromSystemServer();
6069 }
6070 }
6071
6072 /**
Michal Karpinski6235a942016-03-15 12:07:23 +00006073 * Return whether security logging is enabled or not by the device owner.
6074 *
6075 * <p>Can only be called by the device owner, otherwise a {@link SecurityException} will be
6076 * thrown.
6077 *
6078 * @param admin Which device owner this request is associated with.
6079 * @return {@code true} if security logging is enabled by device owner, {@code false} otherwise.
6080 * @throws SecurityException if {@code admin} is not a device owner.
6081 */
6082 public boolean isSecurityLoggingEnabled(@NonNull ComponentName admin) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01006083 throwIfParentInstance("isSecurityLoggingEnabled");
Rubin Xuc3cd05f2016-01-11 12:11:35 +00006084 try {
Michal Karpinski6235a942016-03-15 12:07:23 +00006085 return mService.isSecurityLoggingEnabled(admin);
Rubin Xuc3cd05f2016-01-11 12:11:35 +00006086 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07006087 throw re.rethrowFromSystemServer();
Rubin Xuc3cd05f2016-01-11 12:11:35 +00006088 }
6089 }
6090
6091 /**
Michal Karpinski6235a942016-03-15 12:07:23 +00006092 * Called by device owner to retrieve all new security logging entries since the last call to
6093 * this API after device boots.
6094 *
6095 * <p> Access to the logs is rate limited and it will only return new logs after the device
6096 * owner has been notified via {@link DeviceAdminReceiver#onSecurityLogsAvailable}.
6097 *
6098 * <p>There must be only one user on the device, managed by the device owner.
6099 * Otherwise a {@link SecurityException} will be thrown.
Michal Karpinskib58e4962016-03-01 14:55:10 +00006100 *
Rubin Xuc3cd05f2016-01-11 12:11:35 +00006101 * @param admin Which device owner this request is associated with.
Michal Karpinski6235a942016-03-15 12:07:23 +00006102 * @return the new batch of security logs which is a list of {@link SecurityEvent},
6103 * or {@code null} if rate limitation is exceeded or if logging is currently disabled.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07006104 * @throws SecurityException if {@code admin} is not a device owner.
Rubin Xuc3cd05f2016-01-11 12:11:35 +00006105 */
Michal Karpinski6235a942016-03-15 12:07:23 +00006106 public List<SecurityEvent> retrieveSecurityLogs(@NonNull ComponentName admin) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01006107 throwIfParentInstance("retrieveSecurityLogs");
Rubin Xuc3cd05f2016-01-11 12:11:35 +00006108 try {
Michal Karpinski6235a942016-03-15 12:07:23 +00006109 ParceledListSlice<SecurityEvent> list = mService.retrieveSecurityLogs(admin);
Rubin Xuc3cd05f2016-01-11 12:11:35 +00006110 if (list != null) {
6111 return list.getList();
6112 } else {
6113 // Rate limit exceeded.
6114 return null;
6115 }
Clara Bayarri3e826ef2015-12-14 17:51:22 +00006116 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07006117 throw re.rethrowFromSystemServer();
Clara Bayarri3e826ef2015-12-14 17:51:22 +00006118 }
6119 }
Benjamin Franz59720bb2016-01-18 15:26:11 +00006120
6121 /**
Sudheer Shanka978fc0d2016-01-28 13:51:10 +00006122 * Called by the system to obtain a {@link DevicePolicyManager} whose calls act on the parent
6123 * profile.
6124 *
6125 * @hide
6126 */
6127 public DevicePolicyManager getParentProfileInstance(UserInfo uInfo) {
6128 mContext.checkSelfPermission(
6129 android.Manifest.permission.MANAGE_PROFILE_AND_DEVICE_OWNERS);
6130 if (!uInfo.isManagedProfile()) {
6131 throw new SecurityException("The user " + uInfo.id
6132 + " does not have a parent profile.");
6133 }
6134 return new DevicePolicyManager(mContext, true);
6135 }
6136
6137 /**
Rubin Xuc3cd05f2016-01-11 12:11:35 +00006138 * Called by device owners to retrieve device logs from before the device's last reboot.
Rubin Xuc3cd05f2016-01-11 12:11:35 +00006139 * <p>
Rubin Xu0fb6b9e2016-05-04 19:01:07 +01006140 * <strong> This API is not supported on all devices. Calling this API on unsupported devices
6141 * will result in {@code null} being returned. The device logs are retrieved from a RAM region
6142 * which is not guaranteed to be corruption-free during power cycles, as a result be cautious
6143 * about data corruption when parsing. </strong>
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07006144 * <p>
6145 * There must be only one user on the device, managed by the device owner. Otherwise a
6146 * {@link SecurityException} will be thrown.
Michal Karpinskib58e4962016-03-01 14:55:10 +00006147 *
Rubin Xuc3cd05f2016-01-11 12:11:35 +00006148 * @param admin Which device owner this request is associated with.
Rubin Xu0fb6b9e2016-05-04 19:01:07 +01006149 * @return Device logs from before the latest reboot of the system, or {@code null} if this API
6150 * is not supported on the device.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07006151 * @throws SecurityException if {@code admin} is not a device owner.
Rubin Xuc3cd05f2016-01-11 12:11:35 +00006152 */
Michal Karpinski6235a942016-03-15 12:07:23 +00006153 public List<SecurityEvent> retrievePreRebootSecurityLogs(@NonNull ComponentName admin) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01006154 throwIfParentInstance("retrievePreRebootSecurityLogs");
Rubin Xuc3cd05f2016-01-11 12:11:35 +00006155 try {
Michal Karpinski6235a942016-03-15 12:07:23 +00006156 ParceledListSlice<SecurityEvent> list = mService.retrievePreRebootSecurityLogs(admin);
Rubin Xu0fb6b9e2016-05-04 19:01:07 +01006157 if (list != null) {
6158 return list.getList();
6159 } else {
6160 return null;
6161 }
Rubin Xuc3cd05f2016-01-11 12:11:35 +00006162 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07006163 throw re.rethrowFromSystemServer();
Rubin Xuc3cd05f2016-01-11 12:11:35 +00006164 }
6165 }
6166
6167 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07006168 * Called by a profile owner of a managed profile to set the color used for customization. This
6169 * color is used as background color of the confirm credentials screen for that user. The
Clara Bayarri8d0bd7fa2016-03-30 14:59:58 +01006170 * default color is teal (#00796B).
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07006171 * <p>
6172 * The confirm credentials screen can be created using
Benjamin Franz59720bb2016-01-18 15:26:11 +00006173 * {@link android.app.KeyguardManager#createConfirmDeviceCredentialIntent}.
6174 *
6175 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
Michal Karpinski74cd7302016-04-12 15:17:36 +01006176 * @param color The 24bit (0xRRGGBB) representation of the color to be used.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07006177 * @throws SecurityException if {@code admin} is not a profile owner.
Benjamin Franz59720bb2016-01-18 15:26:11 +00006178 */
6179 public void setOrganizationColor(@NonNull ComponentName admin, int color) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01006180 throwIfParentInstance("setOrganizationColor");
Benjamin Franz59720bb2016-01-18 15:26:11 +00006181 try {
Michal Karpinski74cd7302016-04-12 15:17:36 +01006182 // always enforce alpha channel to have 100% opacity
6183 color |= 0xFF000000;
Benjamin Franz59720bb2016-01-18 15:26:11 +00006184 mService.setOrganizationColor(admin, color);
6185 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07006186 throw re.rethrowFromSystemServer();
Benjamin Franz59720bb2016-01-18 15:26:11 +00006187 }
6188 }
6189
6190 /**
Nicolas Prevot8f7698a2016-02-11 16:05:33 +00006191 * @hide
6192 *
6193 * Sets the color used for customization.
6194 *
Michal Karpinski74cd7302016-04-12 15:17:36 +01006195 * @param color The 24bit (0xRRGGBB) representation of the color to be used.
Nicolas Prevot8f7698a2016-02-11 16:05:33 +00006196 * @param userId which user to set the color to.
6197 * @RequiresPermission(allOf = {
6198 * Manifest.permission.MANAGE_USERS,
6199 * Manifest.permission.INTERACT_ACROSS_USERS_FULL})
6200 */
6201 public void setOrganizationColorForUser(@ColorInt int color, @UserIdInt int userId) {
6202 try {
Michal Karpinski74cd7302016-04-12 15:17:36 +01006203 // always enforce alpha channel to have 100% opacity
6204 color |= 0xFF000000;
Nicolas Prevot8f7698a2016-02-11 16:05:33 +00006205 mService.setOrganizationColorForUser(color, userId);
6206 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07006207 throw re.rethrowFromSystemServer();
Nicolas Prevot8f7698a2016-02-11 16:05:33 +00006208 }
6209 }
6210
6211 /**
Benjamin Franz59720bb2016-01-18 15:26:11 +00006212 * Called by a profile owner of a managed profile to retrieve the color used for customization.
6213 * This color is used as background color of the confirm credentials screen for that user.
6214 *
6215 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
Michal Karpinski74cd7302016-04-12 15:17:36 +01006216 * @return The 24bit (0xRRGGBB) representation of the color to be used.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07006217 * @throws SecurityException if {@code admin} is not a profile owner.
Benjamin Franz59720bb2016-01-18 15:26:11 +00006218 */
Michal Karpinski74cd7302016-04-12 15:17:36 +01006219 public @ColorInt int getOrganizationColor(@NonNull ComponentName admin) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01006220 throwIfParentInstance("getOrganizationColor");
Benjamin Franz59720bb2016-01-18 15:26:11 +00006221 try {
6222 return mService.getOrganizationColor(admin);
6223 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07006224 throw re.rethrowFromSystemServer();
Benjamin Franz59720bb2016-01-18 15:26:11 +00006225 }
6226 }
6227
6228 /**
6229 * @hide
6230 * Retrieve the customization color for a given user.
6231 *
6232 * @param userHandle The user id of the user we're interested in.
Michal Karpinski74cd7302016-04-12 15:17:36 +01006233 * @return The 24bit (0xRRGGBB) representation of the color to be used.
Benjamin Franz59720bb2016-01-18 15:26:11 +00006234 */
Michal Karpinski74cd7302016-04-12 15:17:36 +01006235 public @ColorInt int getOrganizationColorForUser(int userHandle) {
Benjamin Franz59720bb2016-01-18 15:26:11 +00006236 try {
6237 return mService.getOrganizationColorForUser(userHandle);
6238 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07006239 throw re.rethrowFromSystemServer();
Benjamin Franz59720bb2016-01-18 15:26:11 +00006240 }
6241 }
Bartosz Fabianowski4c052f22016-01-25 14:18:43 +01006242
6243 /**
Benjamin Franz3e8a7092016-01-25 16:19:08 +00006244 * Called by a profile owner of a managed profile to set the name of the organization under
6245 * management.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07006246 * <p>
6247 * If the organization name needs to be localized, it is the responsibility of the
Benjamin Franz3e8a7092016-01-25 16:19:08 +00006248 * {@link DeviceAdminReceiver} to listen to the {@link Intent#ACTION_LOCALE_CHANGED} broadcast
6249 * and set a new version of this string accordingly.
6250 *
6251 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
6252 * @param title The organization name or {@code null} to clear a previously set name.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07006253 * @throws SecurityException if {@code admin} is not a profile owner.
Benjamin Franz3e8a7092016-01-25 16:19:08 +00006254 */
Michal Karpinski74cd7302016-04-12 15:17:36 +01006255 public void setOrganizationName(@NonNull ComponentName admin, @Nullable CharSequence title) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01006256 throwIfParentInstance("setOrganizationName");
Benjamin Franz3e8a7092016-01-25 16:19:08 +00006257 try {
6258 mService.setOrganizationName(admin, title);
6259 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07006260 throw re.rethrowFromSystemServer();
Benjamin Franz3e8a7092016-01-25 16:19:08 +00006261 }
6262 }
6263
6264 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07006265 * Called by a profile owner of a managed profile to retrieve the name of the organization under
6266 * management.
Benjamin Franz3e8a7092016-01-25 16:19:08 +00006267 *
6268 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
6269 * @return The organization name or {@code null} if none is set.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07006270 * @throws SecurityException if {@code admin} is not a profile owner.
Benjamin Franz3e8a7092016-01-25 16:19:08 +00006271 */
Michal Karpinski74cd7302016-04-12 15:17:36 +01006272 public CharSequence getOrganizationName(@NonNull ComponentName admin) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01006273 throwIfParentInstance("getOrganizationName");
Benjamin Franz3e8a7092016-01-25 16:19:08 +00006274 try {
6275 return mService.getOrganizationName(admin);
6276 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07006277 throw re.rethrowFromSystemServer();
Benjamin Franz3e8a7092016-01-25 16:19:08 +00006278 }
6279 }
6280
6281 /**
6282 * Retrieve the default title message used in the confirm credentials screen for a given user.
6283 *
6284 * @param userHandle The user id of the user we're interested in.
6285 * @return The organization name or {@code null} if none is set.
6286 *
6287 * @hide
6288 */
Michal Karpinski74cd7302016-04-12 15:17:36 +01006289 public CharSequence getOrganizationNameForUser(int userHandle) {
Benjamin Franz3e8a7092016-01-25 16:19:08 +00006290 try {
6291 return mService.getOrganizationNameForUser(userHandle);
6292 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07006293 throw re.rethrowFromSystemServer();
Benjamin Franz3e8a7092016-01-25 16:19:08 +00006294 }
6295 }
6296
6297 /**
Alan Treadwayafad8782016-01-19 15:15:08 +00006298 * @return the {@link UserProvisioningState} for the current user - for unmanaged users will
6299 * return {@link #STATE_USER_UNMANAGED}
6300 * @hide
6301 */
Benjamin Franzeed2a8e2016-02-19 14:19:05 +00006302 @SystemApi
Alan Treadwayafad8782016-01-19 15:15:08 +00006303 @UserProvisioningState
6304 public int getUserProvisioningState() {
Benjamin Franzbc33c822016-04-15 08:57:52 +01006305 throwIfParentInstance("getUserProvisioningState");
Alan Treadwayafad8782016-01-19 15:15:08 +00006306 if (mService != null) {
6307 try {
6308 return mService.getUserProvisioningState();
6309 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07006310 throw e.rethrowFromSystemServer();
Alan Treadwayafad8782016-01-19 15:15:08 +00006311 }
6312 }
6313 return STATE_USER_UNMANAGED;
6314 }
6315
6316 /**
6317 * Set the {@link UserProvisioningState} for the supplied user, if they are managed.
6318 *
6319 * @param state to store
6320 * @param userHandle for user
6321 * @hide
6322 */
6323 public void setUserProvisioningState(@UserProvisioningState int state, int userHandle) {
6324 if (mService != null) {
6325 try {
6326 mService.setUserProvisioningState(state, userHandle);
6327 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07006328 throw e.rethrowFromSystemServer();
Alan Treadwayafad8782016-01-19 15:15:08 +00006329 }
6330 }
6331 }
6332
6333 /**
Bartosz Fabianowski4c052f22016-01-25 14:18:43 +01006334 * @hide
6335 * Indicates the entity that controls the device or profile owner. A user/profile is considered
6336 * affiliated if it is managed by the same entity as the device.
6337 *
6338 * <p> By definition, the user that the device owner runs on is always affiliated. Any other
6339 * user/profile is considered affiliated if the following conditions are both met:
6340 * <ul>
6341 * <li>The device owner and the user's/profile's profile owner have called this method,
6342 * specifying a set of opaque affiliation ids each. If the sets specified by the device owner
6343 * and a profile owner intersect, they must have come from the same source, which means that
6344 * the device owner and profile owner are controlled by the same entity.</li>
6345 * <li>The device owner's and profile owner's package names are the same.</li>
6346 * </ul>
6347 *
6348 * @param admin Which profile or device owner this request is associated with.
6349 * @param ids A set of opaque affiliation ids.
6350 */
6351 public void setAffiliationIds(@NonNull ComponentName admin, Set<String> ids) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01006352 throwIfParentInstance("setAffiliationIds");
Bartosz Fabianowski4c052f22016-01-25 14:18:43 +01006353 try {
6354 mService.setAffiliationIds(admin, new ArrayList<String>(ids));
6355 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07006356 throw e.rethrowFromSystemServer();
Bartosz Fabianowski4c052f22016-01-25 14:18:43 +01006357 }
6358 }
6359
6360 /**
6361 * @hide
6362 * Returns whether this user/profile is affiliated with the device. See
6363 * {@link #setAffiliationIds} for the definition of affiliation.
6364 *
6365 * @return whether this user/profile is affiliated with the device.
6366 */
6367 public boolean isAffiliatedUser() {
Benjamin Franzbc33c822016-04-15 08:57:52 +01006368 throwIfParentInstance("isAffiliatedUser");
Bartosz Fabianowski4c052f22016-01-25 14:18:43 +01006369 try {
6370 return mService != null && mService.isAffiliatedUser();
6371 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07006372 throw e.rethrowFromSystemServer();
Bartosz Fabianowski4c052f22016-01-25 14:18:43 +01006373 }
6374 }
Suprabh Shuklaa2ae2232016-01-28 18:05:14 -08006375
6376 /**
6377 * @hide
6378 * Returns whether the uninstall for {@code packageName} for the current user is in queue
6379 * to be started
6380 * @param packageName the package to check for
6381 * @return whether the uninstall intent for {@code packageName} is pending
6382 */
6383 public boolean isUninstallInQueue(String packageName) {
6384 try {
6385 return mService.isUninstallInQueue(packageName);
6386 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07006387 throw re.rethrowFromSystemServer();
Suprabh Shuklaa2ae2232016-01-28 18:05:14 -08006388 }
6389 }
6390
6391 /**
6392 * @hide
6393 * @param packageName the package containing active DAs to be uninstalled
6394 */
6395 public void uninstallPackageWithActiveAdmins(String packageName) {
6396 try {
6397 mService.uninstallPackageWithActiveAdmins(packageName);
6398 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07006399 throw re.rethrowFromSystemServer();
Suprabh Shuklaa2ae2232016-01-28 18:05:14 -08006400 }
6401 }
Benjamin Franzbc33c822016-04-15 08:57:52 +01006402
Kenny Guy38dcca52016-04-19 13:09:18 +01006403 /**
6404 * @hide
6405 * Remove a test admin synchronously without sending it a broadcast about being removed.
6406 * If the admin is a profile owner or device owner it will still be removed.
6407 *
6408 * @param userHandle user id to remove the admin for.
6409 * @param admin The administration compononent to remove.
6410 * @throws SecurityException if the caller is not shell / root or the admin package
6411 * isn't a test application see {@link ApplicationInfo#FLAG_TEST_APP}.
6412 */
6413 public void forceRemoveActiveAdmin(ComponentName adminReceiver, int userHandle) {
6414 try {
6415 mService.forceRemoveActiveAdmin(adminReceiver, userHandle);
6416 } catch (RemoteException re) {
6417 throw re.rethrowFromSystemServer();
6418 }
6419 }
6420
Benjamin Franzbc33c822016-04-15 08:57:52 +01006421 private void throwIfParentInstance(String functionName) {
6422 if (mParentInstance) {
6423 throw new SecurityException(functionName + " cannot be called on the parent instance");
6424 }
6425 }
Dianne Hackbornd6847842010-01-12 18:14:19 -08006426}