DevicePolicyManager.java revision 60df33da547f066e6840539b02bd9e4da9dd00d5
1/*
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
17package android.app.admin;
18
19import android.annotation.ColorInt;
20import android.annotation.IntDef;
21import android.annotation.NonNull;
22import android.annotation.Nullable;
23import android.annotation.SdkConstant;
24import android.annotation.SdkConstant.SdkConstantType;
25import android.annotation.SystemApi;
26import android.annotation.UserIdInt;
27import android.app.Activity;
28import android.app.admin.SecurityLog.SecurityEvent;
29import android.content.ComponentName;
30import android.content.Context;
31import android.content.Intent;
32import android.content.IntentFilter;
33import android.content.pm.PackageManager;
34import android.content.pm.PackageManager.NameNotFoundException;
35import android.content.pm.ParceledListSlice;
36import android.content.pm.UserInfo;
37import android.graphics.Bitmap;
38import android.net.ProxyInfo;
39import android.net.Uri;
40import android.os.Bundle;
41import android.os.PersistableBundle;
42import android.os.Process;
43import android.os.RemoteCallback;
44import android.os.RemoteException;
45import android.os.ServiceManager;
46import android.os.UserHandle;
47import android.os.UserManager;
48import android.provider.ContactsContract.Directory;
49import android.provider.Settings;
50import android.security.Credentials;
51import android.service.restrictions.RestrictionsReceiver;
52import android.telephony.TelephonyManager;
53import android.util.Log;
54
55import com.android.internal.annotations.VisibleForTesting;
56import com.android.org.conscrypt.TrustedCertificateStore;
57
58import java.io.ByteArrayInputStream;
59import java.io.IOException;
60import java.lang.annotation.Retention;
61import java.lang.annotation.RetentionPolicy;
62import java.net.InetSocketAddress;
63import java.net.Proxy;
64import java.security.KeyFactory;
65import java.security.NoSuchAlgorithmException;
66import java.security.PrivateKey;
67import java.security.cert.Certificate;
68import java.security.cert.CertificateException;
69import java.security.cert.CertificateFactory;
70import java.security.cert.X509Certificate;
71import java.security.spec.InvalidKeySpecException;
72import java.security.spec.PKCS8EncodedKeySpec;
73import java.util.ArrayList;
74import java.util.Arrays;
75import java.util.Collections;
76import java.util.List;
77import java.util.Set;
78
79/**
80 * Public interface for managing policies enforced on a device. Most clients of this class must be
81 * 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.
87 * <div class="special reference">
88 * <h3>Developer Guides</h3>
89 * <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>
93 */
94public class DevicePolicyManager {
95    private static String TAG = "DevicePolicyManager";
96
97    private final Context mContext;
98    private final IDevicePolicyManager mService;
99    private final boolean mParentInstance;
100
101    private DevicePolicyManager(Context context, boolean parentInstance) {
102        this(context,
103                IDevicePolicyManager.Stub.asInterface(
104                        ServiceManager.getService(Context.DEVICE_POLICY_SERVICE)),
105                parentInstance);
106    }
107
108    /** @hide */
109    @VisibleForTesting
110    protected DevicePolicyManager(
111            Context context, IDevicePolicyManager service, boolean parentInstance) {
112        mContext = context;
113        mService = service;
114        mParentInstance = parentInstance;
115    }
116
117    /** @hide */
118    public static DevicePolicyManager create(Context context) {
119        DevicePolicyManager me = new DevicePolicyManager(context, false);
120        return me.mService != null ? me : null;
121    }
122
123    /** @hide test will override it. */
124    @VisibleForTesting
125    protected int myUserId() {
126        return UserHandle.myUserId();
127    }
128
129    /**
130     * Activity action: Starts the provisioning flow which sets up a managed profile.
131     *
132     * <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     *
136     * <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.
139     *
140     * <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
144     * extra {@link #EXTRA_PROVISIONING_DEVICE_ADMIN_PACKAGE_NAME}.
145     * As of {@link android.os.Build.VERSION_CODES#M}, it should contain the extra
146     * {@link #EXTRA_PROVISIONING_DEVICE_ADMIN_COMPONENT_NAME} instead, although specifying only
147     * {@link #EXTRA_PROVISIONING_DEVICE_ADMIN_PACKAGE_NAME} is still supported.
148     *
149     * <p>The intent may also contain the following extras:
150     * <ul>
151     * <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>
157     * </ul>
158     *
159     * <p>When managed provisioning has completed, broadcasts are sent to the application specified
160     * 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.
164     *
165     * <p>If provisioning fails, the managedProfile is removed so the device returns to its
166     * previous state.
167     *
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.
173     */
174    @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
175    public static final String ACTION_PROVISION_MANAGED_PROFILE
176        = "android.app.action.PROVISION_MANAGED_PROFILE";
177
178    /**
179     * 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).
182     * Provisioning configures the user as managed user and sets the MDM as the profile
183     * 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     *
187     * <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>
195     *
196     * <p>If provisioning fails, the device returns to its previous state.
197     *
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.
203     *
204     * @hide
205     */
206    @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
207    public static final String ACTION_PROVISION_MANAGED_USER
208        = "android.app.action.PROVISION_MANAGED_USER";
209
210    /**
211     * 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.
222     * It is possible to check if provisioning is allowed or not by querying the method
223     * {@link #isProvisioningAllowed(String)}.
224     *
225     * <p>The intent contains the following extras:
226     * <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>
230     * <li>{@link #EXTRA_PROVISIONING_ADMIN_EXTRAS_BUNDLE}, optional</li>
231     * <li>{@link #EXTRA_PROVISIONING_LOGO_URI}, optional</li>
232     * <li>{@link #EXTRA_PROVISIONING_MAIN_COLOR}, optional</li>
233     * </ul>
234     *
235     * <p>When device owner provisioning has completed, an intent of the type
236     * {@link DeviceAdminReceiver#ACTION_PROFILE_PROVISIONING_COMPLETE} is broadcast to the
237     * device owner.
238     *
239     * <p>If provisioning fails, the device is factory reset.
240     *
241     * <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.
245     */
246    @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
247    public static final String ACTION_PROVISION_MANAGED_DEVICE
248        = "android.app.action.PROVISION_MANAGED_DEVICE";
249
250    /**
251     * Activity action: Starts the provisioning flow which sets up a managed device.
252     *
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.
294     * 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     *
303     * <p>During device owner provisioning a device admin app is set as the owner of the device.
304     * A device owner has full control over the device. The device owner can not be modified by the
305     * user.
306     *
307     * <p>A typical use case would be a device that is owned by a company, but used by either an
308     * employee or client.
309     *
310     * <p>An intent with this action can be sent only on an unprovisioned device.
311     * 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>
320     * <li>{@link #EXTRA_PROVISIONING_LOGO_URI}, optional</li>
321     * <li>{@link #EXTRA_PROVISIONING_MAIN_COLOR}, optional</li>
322     * </ul>
323     *
324     * <p>When device owner provisioning has completed, an intent of the type
325     * {@link DeviceAdminReceiver#ACTION_PROFILE_PROVISIONING_COMPLETE} is broadcast to the
326     * device owner.
327     *
328     * <p>If provisioning fails, the device is factory reset.
329     *
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    /**
342     * 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     */
352    @SystemApi
353    @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
354    public static final String ACTION_PROVISION_FINALIZATION
355            = "android.app.action.PROVISION_FINALIZATION";
356
357    /**
358     * 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    /**
420     * A {@link android.os.Parcelable} extra of type {@link android.os.PersistableBundle} that
421     * 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.
423     * <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.
428     * 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     *
434     * <p>
435     * In both cases the application receives the data in
436     * {@link DeviceAdminReceiver#onProfileProvisioningComplete} via an intent with the action
437     * {@link DeviceAdminReceiver#ACTION_PROFILE_PROVISIONING_COMPLETE}. The bundle is not changed
438     * during the managed provisioning.
439     */
440    public static final String EXTRA_PROVISIONING_ADMIN_EXTRAS_BUNDLE =
441            "android.app.extra.PROVISIONING_ADMIN_EXTRAS_BUNDLE";
442
443    /**
444     * 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     *
451     * <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}.
453     *
454     * <p> When this extra is set, the application must have exactly one device admin receiver.
455     * This receiver will be set as the profile or device owner and active admin.
456     *
457     * @see DeviceAdminReceiver
458     * @deprecated Use {@link #EXTRA_PROVISIONING_DEVICE_ADMIN_COMPONENT_NAME}. This extra is still
459     * 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}.
461     */
462    @Deprecated
463    public static final String EXTRA_PROVISIONING_DEVICE_ADMIN_PACKAGE_NAME
464        = "android.app.extra.PROVISIONING_DEVICE_ADMIN_PACKAGE_NAME";
465
466    /**
467     * 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
471     * {@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.
474     *
475     * <p>This component is set as device owner and active admin when device owner provisioning is
476     * started by an intent with action {@link #ACTION_PROVISION_MANAGED_DEVICE} or by an NFC
477     * message containing an NFC record with MIME type
478     * {@link #MIME_TYPE_PROVISIONING_NFC}. For the NFC record, the component name must be
479     * flattened to a string, via {@link ComponentName#flattenToShortString()}.
480     *
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    /**
487     * 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    /**
498     * 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}.
501     *
502     * <p> This extra is part of the {@link #EXTRA_PROVISIONING_ADMIN_EXTRAS_BUNDLE}.
503     *
504     * <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.
509     */
510    public static final String EXTRA_PROVISIONING_EMAIL_ADDRESS
511        = "android.app.extra.PROVISIONING_EMAIL_ADDRESS";
512
513    /**
514     * 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.
516     *
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    /**
524     * A Boolean extra that can be used by the mobile device management application to skip the
525     * disabling of system apps during provisioning when set to {@code true}.
526     *
527     * <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.
529     */
530    public static final String EXTRA_PROVISIONING_LEAVE_ALL_SYSTEM_APPS_ENABLED =
531            "android.app.extra.PROVISIONING_LEAVE_ALL_SYSTEM_APPS_ENABLED";
532
533    /**
534     * A String extra holding the time zone {@link android.app.AlarmManager} that the device
535     * will be set to.
536     *
537     * <p>Use in an NFC record with {@link #MIME_TYPE_PROVISIONING_NFC} that starts device owner
538     * provisioning via an NFC bump.
539     */
540    public static final String EXTRA_PROVISIONING_TIME_ZONE
541        = "android.app.extra.PROVISIONING_TIME_ZONE";
542
543    /**
544     * A Long extra holding the wall clock time (in milliseconds) to be set on the device's
545     * {@link android.app.AlarmManager}.
546     *
547     * <p>Use in an NFC record with {@link #MIME_TYPE_PROVISIONING_NFC} that starts device owner
548     * provisioning via an NFC bump.
549     */
550    public static final String EXTRA_PROVISIONING_LOCAL_TIME
551        = "android.app.extra.PROVISIONING_LOCAL_TIME";
552
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     *
557     * <p>Use in an NFC record with {@link #MIME_TYPE_PROVISIONING_NFC} that starts device owner
558     * provisioning via an NFC bump.
559     */
560    public static final String EXTRA_PROVISIONING_LOCALE
561        = "android.app.extra.PROVISIONING_LOCALE";
562
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     *
567     * <p>Use in an NFC record with {@link #MIME_TYPE_PROVISIONING_NFC} that starts device owner
568     * provisioning via an NFC bump.
569     */
570    public static final String EXTRA_PROVISIONING_WIFI_SSID
571        = "android.app.extra.PROVISIONING_WIFI_SSID";
572
573    /**
574     * A boolean extra indicating whether the wifi network in {@link #EXTRA_PROVISIONING_WIFI_SSID}
575     * is hidden or not.
576     *
577     * <p>Use in an NFC record with {@link #MIME_TYPE_PROVISIONING_NFC} that starts device owner
578     * provisioning via an NFC bump.
579     */
580    public static final String EXTRA_PROVISIONING_WIFI_HIDDEN
581        = "android.app.extra.PROVISIONING_WIFI_HIDDEN";
582
583    /**
584     * A String extra indicating the security type of the wifi network in
585     * {@link #EXTRA_PROVISIONING_WIFI_SSID} and could be one of {@code NONE}, {@code WPA} or
586     * {@code WEP}.
587     *
588     * <p>Use in an NFC record with {@link #MIME_TYPE_PROVISIONING_NFC} that starts device owner
589     * provisioning via an NFC bump.
590     */
591    public static final String EXTRA_PROVISIONING_WIFI_SECURITY_TYPE
592        = "android.app.extra.PROVISIONING_WIFI_SECURITY_TYPE";
593
594    /**
595     * A String extra holding the password of the wifi network in
596     * {@link #EXTRA_PROVISIONING_WIFI_SSID}.
597     *
598     * <p>Use in an NFC record with {@link #MIME_TYPE_PROVISIONING_NFC} that starts device owner
599     * provisioning via an NFC bump.
600     */
601    public static final String EXTRA_PROVISIONING_WIFI_PASSWORD
602        = "android.app.extra.PROVISIONING_WIFI_PASSWORD";
603
604    /**
605     * A String extra holding the proxy host for the wifi network in
606     * {@link #EXTRA_PROVISIONING_WIFI_SSID}.
607     *
608     * <p>Use in an NFC record with {@link #MIME_TYPE_PROVISIONING_NFC} that starts device owner
609     * provisioning via an NFC bump.
610     */
611    public static final String EXTRA_PROVISIONING_WIFI_PROXY_HOST
612        = "android.app.extra.PROVISIONING_WIFI_PROXY_HOST";
613
614    /**
615     * An int extra holding the proxy port for the wifi network in
616     * {@link #EXTRA_PROVISIONING_WIFI_SSID}.
617     *
618     * <p>Use in an NFC record with {@link #MIME_TYPE_PROVISIONING_NFC} that starts device owner
619     * provisioning via an NFC bump.
620     */
621    public static final String EXTRA_PROVISIONING_WIFI_PROXY_PORT
622        = "android.app.extra.PROVISIONING_WIFI_PROXY_PORT";
623
624    /**
625     * A String extra holding the proxy bypass for the wifi network in
626     * {@link #EXTRA_PROVISIONING_WIFI_SSID}.
627     *
628     * <p>Use in an NFC record with {@link #MIME_TYPE_PROVISIONING_NFC} that starts device owner
629     * provisioning via an NFC bump.
630     */
631    public static final String EXTRA_PROVISIONING_WIFI_PROXY_BYPASS
632        = "android.app.extra.PROVISIONING_WIFI_PROXY_BYPASS";
633
634    /**
635     * A String extra holding the proxy auto-config (PAC) URL for the wifi network in
636     * {@link #EXTRA_PROVISIONING_WIFI_SSID}.
637     *
638     * <p>Use in an NFC record with {@link #MIME_TYPE_PROVISIONING_NFC} that starts device owner
639     * provisioning via an NFC bump.
640     */
641    public static final String EXTRA_PROVISIONING_WIFI_PAC_URL
642        = "android.app.extra.PROVISIONING_WIFI_PAC_URL";
643
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     *
648     * <p>Use in an NFC record with {@link #MIME_TYPE_PROVISIONING_NFC} that starts device owner
649     * provisioning via an NFC bump.
650     */
651    public static final String EXTRA_PROVISIONING_DEVICE_ADMIN_PACKAGE_DOWNLOAD_LOCATION
652        = "android.app.extra.PROVISIONING_DEVICE_ADMIN_PACKAGE_DOWNLOAD_LOCATION";
653
654    /**
655     * 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     *
660     * <p>Use in an NFC record with {@link #MIME_TYPE_PROVISIONING_NFC} that starts device owner
661     * 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    /**
667     * 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     *
670     * <p>Use in an NFC record with {@link #MIME_TYPE_PROVISIONING_NFC} that starts device owner
671     * provisioning via an NFC bump.
672     */
673    public static final String EXTRA_PROVISIONING_DEVICE_ADMIN_PACKAGE_DOWNLOAD_COOKIE_HEADER
674        = "android.app.extra.PROVISIONING_DEVICE_ADMIN_PACKAGE_DOWNLOAD_COOKIE_HEADER";
675
676    /**
677     * 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}.
680     *
681     * <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
683     * 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.
685     *
686     * <p>Use in an NFC record with {@link #MIME_TYPE_PROVISIONING_NFC} that starts device owner
687     * provisioning via an NFC bump.
688     *
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.
691     * Starting from {@link android.os.Build.VERSION_CODES#M}, this parameter accepts SHA-256 in
692     * addition to SHA-1. Support for SHA-1 is likely to be removed in future OS releases.
693     */
694    public static final String EXTRA_PROVISIONING_DEVICE_ADMIN_PACKAGE_CHECKSUM
695        = "android.app.extra.PROVISIONING_DEVICE_ADMIN_PACKAGE_CHECKSUM";
696
697    /**
698     * A String extra holding the URL-safe base64 encoded SHA-256 checksum of any signature of the
699     * android package archive at the download location specified in {@link
700     * #EXTRA_PROVISIONING_DEVICE_ADMIN_PACKAGE_DOWNLOAD_LOCATION}.
701     *
702     * <p>The signatures of an android package archive can be obtained using
703     * {@link android.content.pm.PackageManager#getPackageArchiveInfo} with flag
704     * {@link android.content.pm.PackageManager#GET_SIGNATURES}.
705     *
706     * <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
708     * 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     */
714    public static final String EXTRA_PROVISIONING_DEVICE_ADMIN_SIGNATURE_CHECKSUM
715        = "android.app.extra.PROVISIONING_DEVICE_ADMIN_SIGNATURE_CHECKSUM";
716
717    /**
718     * 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
722     * intent with action {@link #ACTION_PROVISION_MANAGED_PROFILE}.
723     *
724     * <p>This intent will contain the extra {@link #EXTRA_PROVISIONING_ACCOUNT_TO_MIGRATE} which
725     * 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    /**
732     * A boolean extra indicating whether device encryption can be skipped as part of device owner
733     * or managed profile provisioning.
734     *
735     * <p>Use in an NFC record with {@link #MIME_TYPE_PROVISIONING_NFC} or an intent with action
736     * {@link #ACTION_PROVISION_MANAGED_DEVICE} that starts device owner provisioning.
737     *
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}.
740     */
741    public static final String EXTRA_PROVISIONING_SKIP_ENCRYPTION =
742             "android.app.extra.PROVISIONING_SKIP_ENCRYPTION";
743
744    /**
745     * 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    /**
767     * 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     *
773     * <p>Use in an intent with action {@link #ACTION_PROVISION_MANAGED_DEVICE} or
774     * {@link #ACTION_PROVISION_MANAGED_USER}.
775     *
776     * @hide
777     */
778    public static final String EXTRA_PROVISIONING_SKIP_USER_SETUP =
779            "android.app.extra.PROVISIONING_SKIP_USER_SETUP";
780
781    /**
782     * This MIME type is used for starting the device owner provisioning.
783     *
784     * <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     *
792     * <p> The NFC message must be sent to an unprovisioned device.
793     *
794     * <p>The NFC record must contain a serialized {@link java.util.Properties} object which
795     * contains the following properties:
796     * <ul>
797     * <li>{@link #EXTRA_PROVISIONING_DEVICE_ADMIN_PACKAGE_NAME}</li>
798     * <li>{@link #EXTRA_PROVISIONING_DEVICE_ADMIN_PACKAGE_DOWNLOAD_LOCATION}, optional</li>
799     * <li>{@link #EXTRA_PROVISIONING_DEVICE_ADMIN_PACKAGE_DOWNLOAD_COOKIE_HEADER}, optional</li>
800     * <li>{@link #EXTRA_PROVISIONING_DEVICE_ADMIN_PACKAGE_CHECKSUM}, optional</li>
801     * <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>
811     * <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>
814     *
815     * <p>
816     * As of {@link android.os.Build.VERSION_CODES#M}, the properties should contain
817     * {@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).
820     */
821    public static final String MIME_TYPE_PROVISIONING_NFC
822        = "application/com.android.managedprovisioning";
823
824    /**
825     * 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).
830     *
831     * <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.
834     *
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.
839     */
840    @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
841    public static final String ACTION_ADD_DEVICE_ADMIN
842            = "android.app.action.ADD_DEVICE_ADMIN";
843
844    /**
845     * @hide
846     * Activity action: ask the user to add a new device administrator as the profile owner
847     * for this user. Only system apps can launch this intent.
848     *
849     * <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
851     * to remotely control restrictions on the user.
852     *
853     * <p>The intent must be invoked via {@link Activity#startActivityForResult} to receive the
854     * 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     *
862     * <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.
864     */
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    /**
878     * Broadcast action: send when any policy admin changes a policy.
879     * This is generally used to find out when a new policy is in effect.
880     *
881     * @hide
882     */
883    public static final String ACTION_DEVICE_POLICY_MANAGER_STATE_CHANGED
884            = "android.app.action.DEVICE_POLICY_MANAGER_STATE_CHANGED";
885
886    /**
887     * 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    /**
897     * 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";
902
903    /**
904     * 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";
910
911    /**
912     * 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.
920     *
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.
926     *
927     * @see #ACTION_SET_NEW_PARENT_PROFILE_PASSWORD
928     */
929    @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
930    public static final String ACTION_SET_NEW_PASSWORD
931            = "android.app.action.SET_NEW_PASSWORD";
932
933    /**
934     * 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    /**
944     * 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.
949     */
950    public static final int FLAG_PARENT_CAN_ACCESS_MANAGED = 0x0001;
951
952    /**
953     * 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.
958     */
959    public static final int FLAG_MANAGED_CAN_ACCESS_PARENT = 0x0002;
960
961    /**
962     * 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()}.
964     */
965    @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
966    public static final String ACTION_SYSTEM_UPDATE_POLICY_CHANGED
967            = "android.app.action.SYSTEM_UPDATE_POLICY_CHANGED";
968
969    /**
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
987    /**
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;
1004
1005    /**
1006     * No management for current user in-effect. This is the default.
1007     * @hide
1008     */
1009    @SystemApi
1010    public static final int STATE_USER_UNMANAGED = 0;
1011
1012    /**
1013     * Management partially setup, user setup needs to be completed.
1014     * @hide
1015     */
1016    @SystemApi
1017    public static final int STATE_USER_SETUP_INCOMPLETE = 1;
1018
1019    /**
1020     * Management partially setup, user setup completed.
1021     * @hide
1022     */
1023    @SystemApi
1024    public static final int STATE_USER_SETUP_COMPLETE = 2;
1025
1026    /**
1027     * Management setup and active on current user.
1028     * @hide
1029     */
1030    @SystemApi
1031    public static final int STATE_USER_SETUP_FINALIZED = 3;
1032
1033    /**
1034     * Management partially setup on a managed profile.
1035     * @hide
1036     */
1037    @SystemApi
1038    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    /**
1049     * 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
1054     */
1055    public boolean isAdminActive(@NonNull ComponentName admin) {
1056        return isAdminActiveAsUser(admin, myUserId());
1057    }
1058
1059    /**
1060     * @see #isAdminActive(ComponentName)
1061     * @hide
1062     */
1063    public boolean isAdminActiveAsUser(@NonNull ComponentName admin, int userId) {
1064        if (mService != null) {
1065            try {
1066                return mService.isAdminActive(admin, userId);
1067            } catch (RemoteException e) {
1068                throw e.rethrowFromSystemServer();
1069            }
1070        }
1071        return false;
1072    }
1073    /**
1074     * Return true if the given administrator component is currently being removed
1075     * for the user.
1076     * @hide
1077     */
1078    public boolean isRemovingAdmin(@NonNull ComponentName admin, int userId) {
1079        if (mService != null) {
1080            try {
1081                return mService.isRemovingAdmin(admin, userId);
1082            } catch (RemoteException e) {
1083                throw e.rethrowFromSystemServer();
1084            }
1085        }
1086        return false;
1087    }
1088
1089
1090    /**
1091     * Return a list of all currently active device administrators' component
1092     * names.  If there are no administrators {@code null} may be
1093     * returned.
1094     */
1095    public List<ComponentName> getActiveAdmins() {
1096        throwIfParentInstance("getActiveAdmins");
1097        return getActiveAdminsAsUser(myUserId());
1098    }
1099
1100    /**
1101     * @see #getActiveAdmins()
1102     * @hide
1103     */
1104    public List<ComponentName> getActiveAdminsAsUser(int userId) {
1105        if (mService != null) {
1106            try {
1107                return mService.getActiveAdmins(userId);
1108            } catch (RemoteException e) {
1109                throw e.rethrowFromSystemServer();
1110            }
1111        }
1112        return null;
1113    }
1114
1115    /**
1116     * Used by package administration code to determine if a package can be stopped
1117     * or uninstalled.
1118     * @hide
1119     */
1120    public boolean packageHasActiveAdmins(String packageName) {
1121        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) {
1130        if (mService != null) {
1131            try {
1132                return mService.packageHasActiveAdmins(packageName, userId);
1133            } catch (RemoteException e) {
1134                throw e.rethrowFromSystemServer();
1135            }
1136        }
1137        return false;
1138    }
1139
1140    /**
1141     * 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.
1145     *
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.
1148     *
1149     * @param admin The administration compononent to remove.
1150     * @throws SecurityException if the caller is not in the owner application of {@code admin}.
1151     */
1152    public void removeActiveAdmin(@NonNull ComponentName admin) {
1153        throwIfParentInstance("removeActiveAdmin");
1154        if (mService != null) {
1155            try {
1156                mService.removeActiveAdmin(admin, myUserId());
1157            } catch (RemoteException e) {
1158                throw e.rethrowFromSystemServer();
1159            }
1160        }
1161    }
1162
1163    /**
1164     * 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.
1167     *
1168     * @param admin Which {@link DeviceAdminReceiver} this request is associated with. Must be an
1169     *            active administrator, or an exception will be thrown.
1170     * @param usesPolicy Which uses-policy to check, as defined in {@link DeviceAdminInfo}.
1171     * @throws SecurityException if {@code admin} is not an active administrator.
1172     */
1173    public boolean hasGrantedPolicy(@NonNull ComponentName admin, int usesPolicy) {
1174        throwIfParentInstance("hasGrantedPolicy");
1175        if (mService != null) {
1176            try {
1177                return mService.hasGrantedPolicy(admin, usesPolicy, myUserId());
1178            } catch (RemoteException e) {
1179                throw e.rethrowFromSystemServer();
1180            }
1181        }
1182        return false;
1183    }
1184
1185    /**
1186     * 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) {
1195                throw e.rethrowFromSystemServer();
1196            }
1197        }
1198        return false;
1199    }
1200
1201    /**
1202     * Constant for {@link #setPasswordQuality}: the policy has no requirements
1203     * for the password.  Note that quality constants are ordered so that higher
1204     * values are more restrictive.
1205     */
1206    public static final int PASSWORD_QUALITY_UNSPECIFIED = 0;
1207
1208    /**
1209     * 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    /**
1217     * Constant for {@link #setPasswordQuality}: the policy requires some kind
1218     * of password or pattern, but doesn't care what it is. Note that quality constants
1219     * are ordered so that higher values are more restrictive.
1220     */
1221    public static final int PASSWORD_QUALITY_SOMETHING = 0x10000;
1222
1223    /**
1224     * 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.
1227     */
1228    public static final int PASSWORD_QUALITY_NUMERIC = 0x20000;
1229
1230    /**
1231     * Constant for {@link #setPasswordQuality}: the user must have entered a
1232     * 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
1240     * 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;
1245
1246    /**
1247     * Constant for {@link #setPasswordQuality}: the user must have entered a
1248     * password containing at least <em>both></em> numeric <em>and</em>
1249     * alphabetic (or other symbol) characters.  Note that quality constants are
1250     * ordered so that higher values are more restrictive.
1251     */
1252    public static final int PASSWORD_QUALITY_ALPHANUMERIC = 0x50000;
1253
1254    /**
1255     * Constant for {@link #setPasswordQuality}: the user must have entered a
1256     * 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.
1263     */
1264    public static final int PASSWORD_QUALITY_COMPLEX = 0x60000;
1265
1266    /**
1267     * 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    /**
1279     * 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
1284     * {@link #ACTION_SET_NEW_PARENT_PROFILE_PASSWORD} after calling this method.
1285     * <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.
1297     *
1298     * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
1299     * @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}
1305     */
1306    public void setPasswordQuality(@NonNull ComponentName admin, int quality) {
1307        if (mService != null) {
1308            try {
1309                mService.setPasswordQuality(admin, quality, mParentInstance);
1310            } catch (RemoteException e) {
1311                throw e.rethrowFromSystemServer();
1312            }
1313        }
1314    }
1315
1316    /**
1317     * Retrieve the current minimum password quality for a particular admin or all admins that set
1318     * restrictions 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     *
1325     * @param admin The name of the admin component to check, or {@code null} to aggregate
1326     * all admins.
1327     */
1328    public int getPasswordQuality(@Nullable ComponentName admin) {
1329        return getPasswordQuality(admin, myUserId());
1330    }
1331
1332    /** @hide per-user version */
1333    public int getPasswordQuality(@Nullable ComponentName admin, int userHandle) {
1334        if (mService != null) {
1335            try {
1336                return mService.getPasswordQuality(admin, userHandle, mParentInstance);
1337            } catch (RemoteException e) {
1338                throw e.rethrowFromSystemServer();
1339            }
1340        }
1341        return PASSWORD_QUALITY_UNSPECIFIED;
1342    }
1343
1344    /**
1345     * 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.
1363     *
1364     * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
1365     * @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}
1369     */
1370    public void setPasswordMinimumLength(@NonNull ComponentName admin, int length) {
1371        if (mService != null) {
1372            try {
1373                mService.setPasswordMinimumLength(admin, length, mParentInstance);
1374            } catch (RemoteException e) {
1375                throw e.rethrowFromSystemServer();
1376            }
1377        }
1378    }
1379
1380    /**
1381     * Retrieve the current minimum password length for a particular admin or all admins that set
1382     * restrictions 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     *
1389     * user and its profiles or a particular one.
1390     * @param admin The name of the admin component to check, or {@code null} to aggregate
1391     * all admins.
1392     */
1393    public int getPasswordMinimumLength(@Nullable ComponentName admin) {
1394        return getPasswordMinimumLength(admin, myUserId());
1395    }
1396
1397    /** @hide per-user version */
1398    public int getPasswordMinimumLength(@Nullable ComponentName admin, int userHandle) {
1399        if (mService != null) {
1400            try {
1401                return mService.getPasswordMinimumLength(admin, userHandle, mParentInstance);
1402            } catch (RemoteException e) {
1403                throw e.rethrowFromSystemServer();
1404            }
1405        }
1406        return 0;
1407    }
1408
1409    /**
1410     * 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.
1418     * <p>
1419     * The calling device admin must have requested
1420     * {@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.
1426     *
1427     * @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}
1432     */
1433    public void setPasswordMinimumUpperCase(@NonNull ComponentName admin, int length) {
1434        if (mService != null) {
1435            try {
1436                mService.setPasswordMinimumUpperCase(admin, length, mParentInstance);
1437            } catch (RemoteException e) {
1438                throw e.rethrowFromSystemServer();
1439            }
1440        }
1441    }
1442
1443    /**
1444     * Retrieve the current number of upper case letters required in the password
1445     * for a particular admin or all admins that set restrictions on this user and
1446     * its participating profiles. Restrictions on profiles that have a separate challenge
1447     * are not taken into account.
1448     * This is the same value as set by
1449     * {@link #setPasswordMinimumUpperCase(ComponentName, int)}
1450     * and only applies when the password quality is
1451     * {@link #PASSWORD_QUALITY_COMPLEX}.
1452     *
1453     * <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     *
1457     * @param admin The name of the admin component to check, or {@code null} to
1458     *            aggregate all admins.
1459     * @return The minimum number of upper case letters required in the
1460     *         password.
1461     */
1462    public int getPasswordMinimumUpperCase(@Nullable ComponentName admin) {
1463        return getPasswordMinimumUpperCase(admin, myUserId());
1464    }
1465
1466    /** @hide per-user version */
1467    public int getPasswordMinimumUpperCase(@Nullable ComponentName admin, int userHandle) {
1468        if (mService != null) {
1469            try {
1470                return mService.getPasswordMinimumUpperCase(admin, userHandle, mParentInstance);
1471            } catch (RemoteException e) {
1472                throw e.rethrowFromSystemServer();
1473            }
1474        }
1475        return 0;
1476    }
1477
1478    /**
1479     * 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.
1487     * <p>
1488     * The calling device admin must have requested
1489     * {@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.
1495     *
1496     * @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}
1501     */
1502    public void setPasswordMinimumLowerCase(@NonNull ComponentName admin, int length) {
1503        if (mService != null) {
1504            try {
1505                mService.setPasswordMinimumLowerCase(admin, length, mParentInstance);
1506            } catch (RemoteException e) {
1507                throw e.rethrowFromSystemServer();
1508            }
1509        }
1510    }
1511
1512    /**
1513     * Retrieve the current number of lower case letters required in the password
1514     * for a particular admin or all admins that set restrictions on this user
1515     * and its participating profiles. Restrictions on profiles that have
1516     * a separate challenge are not taken into account.
1517     * This is the same value as set by
1518     * {@link #setPasswordMinimumLowerCase(ComponentName, int)}
1519     * and only applies when the password quality is
1520     * {@link #PASSWORD_QUALITY_COMPLEX}.
1521     *
1522     * <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     *
1526     * @param admin The name of the admin component to check, or {@code null} to
1527     *            aggregate all admins.
1528     * @return The minimum number of lower case letters required in the
1529     *         password.
1530     */
1531    public int getPasswordMinimumLowerCase(@Nullable ComponentName admin) {
1532        return getPasswordMinimumLowerCase(admin, myUserId());
1533    }
1534
1535    /** @hide per-user version */
1536    public int getPasswordMinimumLowerCase(@Nullable ComponentName admin, int userHandle) {
1537        if (mService != null) {
1538            try {
1539                return mService.getPasswordMinimumLowerCase(admin, userHandle, mParentInstance);
1540            } catch (RemoteException e) {
1541                throw e.rethrowFromSystemServer();
1542            }
1543        }
1544        return 0;
1545    }
1546
1547    /**
1548     * 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.
1556     * <p>
1557     * The calling device admin must have requested
1558     * {@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.
1564     *
1565     * @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}
1570     */
1571    public void setPasswordMinimumLetters(@NonNull ComponentName admin, int length) {
1572        if (mService != null) {
1573            try {
1574                mService.setPasswordMinimumLetters(admin, length, mParentInstance);
1575            } catch (RemoteException e) {
1576                throw e.rethrowFromSystemServer();
1577            }
1578        }
1579    }
1580
1581    /**
1582     * Retrieve the current number of letters required in the password
1583     * for a particular admin or all admins that set restrictions 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)}
1588     * and only applies when the password quality is
1589     * {@link #PASSWORD_QUALITY_COMPLEX}.
1590     *
1591     * <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     *
1595     * @param admin The name of the admin component to check, or {@code null} to
1596     *            aggregate all admins.
1597     * @return The minimum number of letters required in the password.
1598     */
1599    public int getPasswordMinimumLetters(@Nullable ComponentName admin) {
1600        return getPasswordMinimumLetters(admin, myUserId());
1601    }
1602
1603    /** @hide per-user version */
1604    public int getPasswordMinimumLetters(@Nullable ComponentName admin, int userHandle) {
1605        if (mService != null) {
1606            try {
1607                return mService.getPasswordMinimumLetters(admin, userHandle, mParentInstance);
1608            } catch (RemoteException e) {
1609                throw e.rethrowFromSystemServer();
1610            }
1611        }
1612        return 0;
1613    }
1614
1615    /**
1616     * 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.
1624     * <p>
1625     * The calling device admin must have requested
1626     * {@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.
1632     *
1633     * @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}
1638     */
1639    public void setPasswordMinimumNumeric(@NonNull ComponentName admin, int length) {
1640        if (mService != null) {
1641            try {
1642                mService.setPasswordMinimumNumeric(admin, length, mParentInstance);
1643            } catch (RemoteException e) {
1644                throw e.rethrowFromSystemServer();
1645            }
1646        }
1647    }
1648
1649    /**
1650     * Retrieve the current number of numerical digits required in the password
1651     * for a particular admin or all admins that set restrictions on this user
1652     * and its participating profiles. Restrictions on profiles that have
1653     * a separate challenge are not taken into account.
1654     * This is the same value as set by
1655     * {@link #setPasswordMinimumNumeric(ComponentName, int)}
1656     * and only applies when the password quality is
1657     * {@link #PASSWORD_QUALITY_COMPLEX}.
1658     *
1659     * <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     *
1663     * @param admin The name of the admin component to check, or {@code null} to
1664     *            aggregate all admins.
1665     * @return The minimum number of numerical digits required in the password.
1666     */
1667    public int getPasswordMinimumNumeric(@Nullable ComponentName admin) {
1668        return getPasswordMinimumNumeric(admin, myUserId());
1669    }
1670
1671    /** @hide per-user version */
1672    public int getPasswordMinimumNumeric(@Nullable ComponentName admin, int userHandle) {
1673        if (mService != null) {
1674            try {
1675                return mService.getPasswordMinimumNumeric(admin, userHandle, mParentInstance);
1676            } catch (RemoteException e) {
1677                throw e.rethrowFromSystemServer();
1678            }
1679        }
1680        return 0;
1681    }
1682
1683    /**
1684     * 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.
1692     * <p>
1693     * The calling device admin must have requested
1694     * {@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.
1700     *
1701     * @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}
1706     */
1707    public void setPasswordMinimumSymbols(@NonNull ComponentName admin, int length) {
1708        if (mService != null) {
1709            try {
1710                mService.setPasswordMinimumSymbols(admin, length, mParentInstance);
1711            } catch (RemoteException e) {
1712                throw e.rethrowFromSystemServer();
1713            }
1714        }
1715    }
1716
1717    /**
1718     * Retrieve the current number of symbols required in the password
1719     * for a particular admin or all admins that set restrictions 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)}
1723     * and only applies when the password quality is
1724     * {@link #PASSWORD_QUALITY_COMPLEX}.
1725     *
1726     * <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     *
1730     * @param admin The name of the admin component to check, or {@code null} to
1731     *            aggregate all admins.
1732     * @return The minimum number of symbols required in the password.
1733     */
1734    public int getPasswordMinimumSymbols(@Nullable ComponentName admin) {
1735        return getPasswordMinimumSymbols(admin, myUserId());
1736    }
1737
1738    /** @hide per-user version */
1739    public int getPasswordMinimumSymbols(@Nullable ComponentName admin, int userHandle) {
1740        if (mService != null) {
1741            try {
1742                return mService.getPasswordMinimumSymbols(admin, userHandle, mParentInstance);
1743            } catch (RemoteException e) {
1744                throw e.rethrowFromSystemServer();
1745            }
1746        }
1747        return 0;
1748    }
1749
1750    /**
1751     * 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.
1759     * <p>
1760     * The calling device admin must have requested
1761     * {@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.
1767     *
1768     * @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}
1773     */
1774    public void setPasswordMinimumNonLetter(@NonNull ComponentName admin, int length) {
1775        if (mService != null) {
1776            try {
1777                mService.setPasswordMinimumNonLetter(admin, length, mParentInstance);
1778            } catch (RemoteException e) {
1779                throw e.rethrowFromSystemServer();
1780            }
1781        }
1782    }
1783
1784    /**
1785     * Retrieve the current number of non-letter characters required in the password
1786     * for a particular admin or all admins that set restrictions on this user
1787     * and its participating profiles. Restrictions on profiles that have
1788     * a separate challenge are not taken into account.
1789     * This is the same value as set by
1790     * {@link #setPasswordMinimumNonLetter(ComponentName, int)}
1791     * and only applies when the password quality is
1792     * {@link #PASSWORD_QUALITY_COMPLEX}.
1793     *
1794     * <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     *
1798     * @param admin The name of the admin component to check, or {@code null} to
1799     *            aggregate all admins.
1800     * @return The minimum number of letters required in the password.
1801     */
1802    public int getPasswordMinimumNonLetter(@Nullable ComponentName admin) {
1803        return getPasswordMinimumNonLetter(admin, myUserId());
1804    }
1805
1806    /** @hide per-user version */
1807    public int getPasswordMinimumNonLetter(@Nullable ComponentName admin, int userHandle) {
1808        if (mService != null) {
1809            try {
1810                return mService.getPasswordMinimumNonLetter(admin, userHandle, mParentInstance);
1811            } catch (RemoteException e) {
1812                throw e.rethrowFromSystemServer();
1813            }
1814        }
1815        return 0;
1816    }
1817
1818    /**
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     */
1843    public void setPasswordHistoryLength(@NonNull ComponentName admin, int length) {
1844        if (mService != null) {
1845            try {
1846                mService.setPasswordHistoryLength(admin, length, mParentInstance);
1847            } catch (RemoteException e) {
1848                throw e.rethrowFromSystemServer();
1849            }
1850        }
1851    }
1852
1853    /**
1854     * 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.
1874     *
1875     * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
1876     * @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}
1880     */
1881    public void setPasswordExpirationTimeout(@NonNull ComponentName admin, long timeout) {
1882        if (mService != null) {
1883            try {
1884                mService.setPasswordExpirationTimeout(admin, timeout, mParentInstance);
1885            } catch (RemoteException e) {
1886                throw e.rethrowFromSystemServer();
1887            }
1888        }
1889    }
1890
1891    /**
1892     * 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
1895     * 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.
1901     *
1902     * @param admin The name of the admin component to check, or {@code null} to aggregate all admins.
1903     * @return The timeout for the given admin or the minimum of all timeouts
1904     */
1905    public long getPasswordExpirationTimeout(@Nullable ComponentName admin) {
1906        if (mService != null) {
1907            try {
1908                return mService.getPasswordExpirationTimeout(admin, myUserId(), mParentInstance);
1909            } catch (RemoteException e) {
1910                throw e.rethrowFromSystemServer();
1911            }
1912        }
1913        return 0;
1914    }
1915
1916    /**
1917     * Get the current password expiration time for a particular admin or all admins that set
1918     * restrictions 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.
1925     *
1926     * @param admin The name of the admin component to check, or {@code null} to aggregate all admins.
1927     * @return The password expiration time, in milliseconds since epoch.
1928     */
1929    public long getPasswordExpiration(@Nullable ComponentName admin) {
1930        if (mService != null) {
1931            try {
1932                return mService.getPasswordExpiration(admin, myUserId(), mParentInstance);
1933            } catch (RemoteException e) {
1934                throw e.rethrowFromSystemServer();
1935            }
1936        }
1937        return 0;
1938    }
1939
1940    /**
1941     * Retrieve the current password history length for a particular admin or all admins that
1942     * set restrictions 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     *
1949     * @param admin The name of the admin component to check, or {@code null} to aggregate
1950     * all admins.
1951     * @return The length of the password history
1952     */
1953    public int getPasswordHistoryLength(@Nullable ComponentName admin) {
1954        return getPasswordHistoryLength(admin, myUserId());
1955    }
1956
1957    /** @hide per-user version */
1958    public int getPasswordHistoryLength(@Nullable ComponentName admin, int userHandle) {
1959        if (mService != null) {
1960            try {
1961                return mService.getPasswordHistoryLength(admin, userHandle, mParentInstance);
1962            } catch (RemoteException e) {
1963                throw e.rethrowFromSystemServer();
1964            }
1965        }
1966        return 0;
1967    }
1968
1969    /**
1970     * Return the maximum password length that the device supports for a
1971     * particular password quality.
1972     * @param quality The quality being interrogated.
1973     * @return Returns the maximum length that the user can enter.
1974     */
1975    public int getPasswordMaximumLength(int quality) {
1976        // Kind-of arbitrary.
1977        return 16;
1978    }
1979
1980    /**
1981     * 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.
1993     *
1994     * @return Returns true if the password meets the current requirements, else false.
1995     * @throws SecurityException if the calling application does not own an active administrator
1996     *             that uses {@link DeviceAdminInfo#USES_POLICY_LIMIT_PASSWORD}
1997     */
1998    public boolean isActivePasswordSufficient() {
1999        if (mService != null) {
2000            try {
2001                return mService.isActivePasswordSufficient(myUserId(), mParentInstance);
2002            } catch (RemoteException e) {
2003                throw e.rethrowFromSystemServer();
2004            }
2005        }
2006        return false;
2007    }
2008
2009    /**
2010     * Determine whether the current profile password the user has set is sufficient
2011     * to meet the policy requirements (e.g. quality, minimum length) that have been
2012     * 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.
2016     * @throws SecurityException if {@code userHandle} is not a managed profile.
2017     * @hide
2018     */
2019    public boolean isProfileActivePasswordSufficientForParent(int userHandle) {
2020        if (mService != null) {
2021            try {
2022                return mService.isProfileActivePasswordSufficientForParent(userHandle);
2023            } catch (RemoteException e) {
2024                throw e.rethrowFromSystemServer();
2025            }
2026        }
2027        return false;
2028    }
2029
2030    /**
2031     * 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.
2040     *
2041     * @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}
2045     */
2046    public int getCurrentFailedPasswordAttempts() {
2047        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) {
2061        if (mService != null) {
2062            try {
2063                return mService.getCurrentFailedPasswordAttempts(userHandle, mParentInstance);
2064            } catch (RemoteException e) {
2065                throw e.rethrowFromSystemServer();
2066            }
2067        }
2068        return -1;
2069    }
2070
2071    /**
2072     * Queries whether {@link #RESET_PASSWORD_DO_NOT_ASK_CREDENTIALS_ON_BOOT} flag is set.
2073     *
2074     * @return true if RESET_PASSWORD_DO_NOT_ASK_CREDENTIALS_ON_BOOT flag is set.
2075     * @hide
2076     */
2077    public boolean getDoNotAskCredentialsOnBoot() {
2078        if (mService != null) {
2079            try {
2080                return mService.getDoNotAskCredentialsOnBoot();
2081            } catch (RemoteException e) {
2082                throw e.rethrowFromSystemServer();
2083            }
2084        }
2085        return false;
2086    }
2087
2088    /**
2089     * 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
2093     * {@link DeviceAdminInfo#USES_POLICY_WIPE_DATA}}.
2094     * <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.
2104     *
2105     * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
2106     * @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}.
2111     */
2112    public void setMaximumFailedPasswordsForWipe(@NonNull ComponentName admin, int num) {
2113        if (mService != null) {
2114            try {
2115                mService.setMaximumFailedPasswordsForWipe(admin, num, mParentInstance);
2116            } catch (RemoteException e) {
2117                throw e.rethrowFromSystemServer();
2118            }
2119        }
2120    }
2121
2122    /**
2123     * 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 restrictions 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     *
2132     * @param admin The name of the admin component to check, or {@code null} to aggregate
2133     * all admins.
2134     */
2135    public int getMaximumFailedPasswordsForWipe(@Nullable ComponentName admin) {
2136        return getMaximumFailedPasswordsForWipe(admin, myUserId());
2137    }
2138
2139    /** @hide per-user version */
2140    public int getMaximumFailedPasswordsForWipe(@Nullable ComponentName admin, int userHandle) {
2141        if (mService != null) {
2142            try {
2143                return mService.getMaximumFailedPasswordsForWipe(
2144                        admin, userHandle, mParentInstance);
2145            } catch (RemoteException e) {
2146                throw e.rethrowFromSystemServer();
2147            }
2148        }
2149        return 0;
2150    }
2151
2152    /**
2153     * 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 {
2162                return mService.getProfileWithMinimumFailedPasswordsForWipe(
2163                        userHandle, mParentInstance);
2164            } catch (RemoteException e) {
2165                throw e.rethrowFromSystemServer();
2166            }
2167        }
2168        return UserHandle.USER_NULL;
2169    }
2170
2171    /**
2172     * 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;
2176
2177    /**
2178     * 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     */
2185    public static final int RESET_PASSWORD_DO_NOT_ASK_CREDENTIALS_ON_BOOT = 0x0002;
2186
2187    /**
2188     * 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>
2191     * <em>Note: This API has been limited as of {@link android.os.Build.VERSION_CODES#N} for
2192     * 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 when user is unlocked and does not have a managed
2195     * profile.</em>
2196     * <p>
2197     * The given password must be sufficient for the current password quality and length constraints
2198     * as returned by {@link #getPasswordQuality(ComponentName)} and
2199     * {@link #getPasswordMinimumLength(ComponentName)}; if it does not meet these constraints, then
2200     * it will be rejected and false returned. Note that the password may be a stronger quality
2201     * (containing alphanumeric characters when the requested quality is only numeric), in which
2202     * case the currently active quality will be increased to match.
2203     * <p>
2204     * Calling with a null or empty password will clear any existing PIN, pattern or password if the
2205     * current password constraints allow it. <em>Note: This will not work in
2206     * {@link android.os.Build.VERSION_CODES#N} and later for managed profiles, or for device admins
2207     * that are not device owner or profile owner.  Once set, the password cannot be changed to null
2208     * or empty except by these admins.</em>
2209     * <p>
2210     * The calling device admin must have requested
2211     * {@link DeviceAdminInfo#USES_POLICY_RESET_PASSWORD} to be able to call this method; if it has
2212     * not, a security exception will be thrown.
2213     *
2214     * @param password The new password for the user. Null or empty clears the password.
2215     * @param flags May be 0 or combination of {@link #RESET_PASSWORD_REQUIRE_ENTRY} and
2216     *            {@link #RESET_PASSWORD_DO_NOT_ASK_CREDENTIALS_ON_BOOT}.
2217     * @return Returns true if the password was applied, or false if it is not acceptable for the
2218     *         current constraints or if the user has not been decrypted yet.
2219     * @throws SecurityException if the calling application does not own an active administrator
2220     *             that uses {@link DeviceAdminInfo#USES_POLICY_RESET_PASSWORD}
2221     * @throws IllegalStateException if the calling user is locked or has a managed profile.
2222     * @throws IllegalArgumentException if the password does not meet system requirements.
2223     */
2224    public boolean resetPassword(String password, int flags) {
2225        throwIfParentInstance("resetPassword");
2226        if (mService != null) {
2227            try {
2228                return mService.resetPassword(password, flags);
2229            } catch (RemoteException e) {
2230                throw e.rethrowFromSystemServer();
2231            }
2232        }
2233        return false;
2234    }
2235
2236    /**
2237     * Called by an application that is administering the device to set the maximum time for user
2238     * activity until the device will lock. This limits the length that the user can set. It takes
2239     * effect immediately.
2240     * <p>
2241     * The calling device admin must have requested {@link DeviceAdminInfo#USES_POLICY_FORCE_LOCK}
2242     * to be able to call this method; if it has not, a security exception will be thrown.
2243     * <p>
2244     * This method can be called on the {@link DevicePolicyManager} instance returned by
2245     * {@link #getParentProfileInstance(ComponentName)} in order to set restrictions on the parent
2246     * profile.
2247     *
2248     * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
2249     * @param timeMs The new desired maximum time to lock in milliseconds. A value of 0 means there
2250     *            is no restriction.
2251     * @throws SecurityException if {@code admin} is not an active administrator or it does not use
2252     *             {@link DeviceAdminInfo#USES_POLICY_FORCE_LOCK}
2253     */
2254    public void setMaximumTimeToLock(@NonNull ComponentName admin, long timeMs) {
2255        if (mService != null) {
2256            try {
2257                mService.setMaximumTimeToLock(admin, timeMs, mParentInstance);
2258            } catch (RemoteException e) {
2259                throw e.rethrowFromSystemServer();
2260            }
2261        }
2262    }
2263
2264    /**
2265     * Retrieve the current maximum time to unlock for a particular admin or all admins that set
2266     * restrictions on this user and its participating profiles. Restrictions on profiles that have
2267     * a separate challenge are not taken into account.
2268     *
2269     * <p>This method can be called on the {@link DevicePolicyManager} instance
2270     * returned by {@link #getParentProfileInstance(ComponentName)} in order to retrieve
2271     * restrictions on the parent profile.
2272     *
2273     * @param admin The name of the admin component to check, or {@code null} to aggregate
2274     * all admins.
2275     * @return time in milliseconds for the given admin or the minimum value (strictest) of
2276     * all admins if admin is null. Returns 0 if there are no restrictions.
2277     */
2278    public long getMaximumTimeToLock(@Nullable ComponentName admin) {
2279        return getMaximumTimeToLock(admin, myUserId());
2280    }
2281
2282    /** @hide per-user version */
2283    public long getMaximumTimeToLock(@Nullable ComponentName admin, int userHandle) {
2284        if (mService != null) {
2285            try {
2286                return mService.getMaximumTimeToLock(admin, userHandle, mParentInstance);
2287            } catch (RemoteException e) {
2288                throw e.rethrowFromSystemServer();
2289            }
2290        }
2291        return 0;
2292    }
2293
2294    /**
2295     * Returns maximum time to lock that applied by all profiles in this user. We do this because we
2296     * do not have a separate timeout to lock for work challenge only.
2297     *
2298     * @hide
2299     */
2300    public long getMaximumTimeToLockForUserAndProfiles(int userHandle) {
2301        if (mService != null) {
2302            try {
2303                return mService.getMaximumTimeToLockForUserAndProfiles(userHandle);
2304            } catch (RemoteException e) {
2305                throw e.rethrowFromSystemServer();
2306            }
2307        }
2308        return 0;
2309    }
2310
2311    /**
2312     * Make the device lock immediately, as if the lock screen timeout has expired at the point of
2313     * this call.
2314     * <p>
2315     * The calling device admin must have requested {@link DeviceAdminInfo#USES_POLICY_FORCE_LOCK}
2316     * to be able to call this method; if it has not, a security exception will be thrown.
2317     * <p>
2318     * This method can be called on the {@link DevicePolicyManager} instance returned by
2319     * {@link #getParentProfileInstance(ComponentName)} in order to lock the parent profile.
2320     *
2321     * @throws SecurityException if the calling application does not own an active administrator
2322     *             that uses {@link DeviceAdminInfo#USES_POLICY_FORCE_LOCK}
2323     */
2324    public void lockNow() {
2325        if (mService != null) {
2326            try {
2327                mService.lockNow(mParentInstance);
2328            } catch (RemoteException e) {
2329                throw e.rethrowFromSystemServer();
2330            }
2331        }
2332    }
2333
2334    /**
2335     * Flag for {@link #wipeData(int)}: also erase the device's external
2336     * storage (such as SD cards).
2337     */
2338    public static final int WIPE_EXTERNAL_STORAGE = 0x0001;
2339
2340    /**
2341     * Flag for {@link #wipeData(int)}: also erase the factory reset protection
2342     * data.
2343     *
2344     * <p>This flag may only be set by device owner admins; if it is set by
2345     * other admins a {@link SecurityException} will be thrown.
2346     */
2347    public static final int WIPE_RESET_PROTECTION_DATA = 0x0002;
2348
2349    /**
2350     * Ask the user data be wiped. Wiping the primary user will cause the device to reboot, erasing
2351     * all user data while next booting up.
2352     * <p>
2353     * The calling device admin must have requested {@link DeviceAdminInfo#USES_POLICY_WIPE_DATA} to
2354     * be able to call this method; if it has not, a security exception will be thrown.
2355     *
2356     * @param flags Bit mask of additional options: currently supported flags are
2357     *            {@link #WIPE_EXTERNAL_STORAGE} and {@link #WIPE_RESET_PROTECTION_DATA}.
2358     * @throws SecurityException if the calling application does not own an active administrator
2359     *             that uses {@link DeviceAdminInfo#USES_POLICY_WIPE_DATA}
2360     */
2361    public void wipeData(int flags) {
2362        throwIfParentInstance("wipeData");
2363        if (mService != null) {
2364            try {
2365                mService.wipeData(flags);
2366            } catch (RemoteException e) {
2367                throw e.rethrowFromSystemServer();
2368            }
2369        }
2370    }
2371
2372    /**
2373     * Called by an application that is administering the device to set the
2374     * global proxy and exclusion list.
2375     * <p>
2376     * The calling device admin must have requested
2377     * {@link DeviceAdminInfo#USES_POLICY_SETS_GLOBAL_PROXY} to be able to call
2378     * this method; if it has not, a security exception will be thrown.
2379     * Only the first device admin can set the proxy. If a second admin attempts
2380     * to set the proxy, the {@link ComponentName} of the admin originally setting the
2381     * proxy will be returned. If successful in setting the proxy, {@code null} will
2382     * be returned.
2383     * The method can be called repeatedly by the device admin alrady setting the
2384     * proxy to update the proxy and exclusion list.
2385     *
2386     * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
2387     * @param proxySpec the global proxy desired. Must be an HTTP Proxy.
2388     *            Pass Proxy.NO_PROXY to reset the proxy.
2389     * @param exclusionList a list of domains to be excluded from the global proxy.
2390     * @return {@code null} if the proxy was successfully set, or otherwise a {@link ComponentName}
2391     *            of the device admin that sets the proxy.
2392     * @hide
2393     */
2394    public ComponentName setGlobalProxy(@NonNull ComponentName admin, Proxy proxySpec,
2395            List<String> exclusionList ) {
2396        throwIfParentInstance("setGlobalProxy");
2397        if (proxySpec == null) {
2398            throw new NullPointerException();
2399        }
2400        if (mService != null) {
2401            try {
2402                String hostSpec;
2403                String exclSpec;
2404                if (proxySpec.equals(Proxy.NO_PROXY)) {
2405                    hostSpec = null;
2406                    exclSpec = null;
2407                } else {
2408                    if (!proxySpec.type().equals(Proxy.Type.HTTP)) {
2409                        throw new IllegalArgumentException();
2410                    }
2411                    InetSocketAddress sa = (InetSocketAddress)proxySpec.address();
2412                    String hostName = sa.getHostName();
2413                    int port = sa.getPort();
2414                    StringBuilder hostBuilder = new StringBuilder();
2415                    hostSpec = hostBuilder.append(hostName)
2416                        .append(":").append(Integer.toString(port)).toString();
2417                    if (exclusionList == null) {
2418                        exclSpec = "";
2419                    } else {
2420                        StringBuilder listBuilder = new StringBuilder();
2421                        boolean firstDomain = true;
2422                        for (String exclDomain : exclusionList) {
2423                            if (!firstDomain) {
2424                                listBuilder = listBuilder.append(",");
2425                            } else {
2426                                firstDomain = false;
2427                            }
2428                            listBuilder = listBuilder.append(exclDomain.trim());
2429                        }
2430                        exclSpec = listBuilder.toString();
2431                    }
2432                    if (android.net.Proxy.validate(hostName, Integer.toString(port), exclSpec)
2433                            != android.net.Proxy.PROXY_VALID)
2434                        throw new IllegalArgumentException();
2435                }
2436                return mService.setGlobalProxy(admin, hostSpec, exclSpec);
2437            } catch (RemoteException e) {
2438                throw e.rethrowFromSystemServer();
2439            }
2440        }
2441        return null;
2442    }
2443
2444    /**
2445     * Set a network-independent global HTTP proxy. This is not normally what you want for typical
2446     * HTTP proxies - they are generally network dependent. However if you're doing something
2447     * unusual like general internal filtering this may be useful. On a private network where the
2448     * proxy is not accessible, you may break HTTP using this.
2449     * <p>
2450     * This method requires the caller to be the device owner.
2451     * <p>
2452     * This proxy is only a recommendation and it is possible that some apps will ignore it.
2453     *
2454     * @see ProxyInfo
2455     * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
2456     * @param proxyInfo The a {@link ProxyInfo} object defining the new global HTTP proxy. A
2457     *            {@code null} value will clear the global HTTP proxy.
2458     * @throws SecurityException if {@code admin} is not the device owner.
2459     */
2460    public void setRecommendedGlobalProxy(@NonNull ComponentName admin, @Nullable ProxyInfo
2461            proxyInfo) {
2462        throwIfParentInstance("setRecommendedGlobalProxy");
2463        if (mService != null) {
2464            try {
2465                mService.setRecommendedGlobalProxy(admin, proxyInfo);
2466            } catch (RemoteException e) {
2467                throw e.rethrowFromSystemServer();
2468            }
2469        }
2470    }
2471
2472    /**
2473     * Returns the component name setting the global proxy.
2474     * @return ComponentName object of the device admin that set the global proxy, or {@code null}
2475     *         if no admin has set the proxy.
2476     * @hide
2477     */
2478    public ComponentName getGlobalProxyAdmin() {
2479        if (mService != null) {
2480            try {
2481                return mService.getGlobalProxyAdmin(myUserId());
2482            } catch (RemoteException e) {
2483                throw e.rethrowFromSystemServer();
2484            }
2485        }
2486        return null;
2487    }
2488
2489    /**
2490     * Result code for {@link #setStorageEncryption} and {@link #getStorageEncryptionStatus}:
2491     * indicating that encryption is not supported.
2492     */
2493    public static final int ENCRYPTION_STATUS_UNSUPPORTED = 0;
2494
2495    /**
2496     * Result code for {@link #setStorageEncryption} and {@link #getStorageEncryptionStatus}:
2497     * indicating that encryption is supported, but is not currently active.
2498     */
2499    public static final int ENCRYPTION_STATUS_INACTIVE = 1;
2500
2501    /**
2502     * Result code for {@link #getStorageEncryptionStatus}:
2503     * indicating that encryption is not currently active, but is currently
2504     * being activated.  This is only reported by devices that support
2505     * encryption of data and only when the storage is currently
2506     * undergoing a process of becoming encrypted.  A device that must reboot and/or wipe data
2507     * to become encrypted will never return this value.
2508     */
2509    public static final int ENCRYPTION_STATUS_ACTIVATING = 2;
2510
2511    /**
2512     * Result code for {@link #setStorageEncryption} and {@link #getStorageEncryptionStatus}:
2513     * indicating that encryption is active.
2514     * <p>
2515     * Also see {@link #ENCRYPTION_STATUS_ACTIVE_PER_USER}.
2516     */
2517    public static final int ENCRYPTION_STATUS_ACTIVE = 3;
2518
2519    /**
2520     * Result code for {@link #getStorageEncryptionStatus}:
2521     * indicating that encryption is active, but an encryption key has not
2522     * been set by the user.
2523     */
2524    public static final int ENCRYPTION_STATUS_ACTIVE_DEFAULT_KEY = 4;
2525
2526    /**
2527     * Result code for {@link #getStorageEncryptionStatus}:
2528     * indicating that encryption is active and the encryption key is tied to the user or profile.
2529     * <p>
2530     * This value is only returned to apps targeting API level 24 and above. For apps targeting
2531     * earlier API levels, {@link #ENCRYPTION_STATUS_ACTIVE} is returned, even if the
2532     * encryption key is specific to the user or profile.
2533     */
2534    public static final int ENCRYPTION_STATUS_ACTIVE_PER_USER = 5;
2535
2536    /**
2537     * Activity action: begin the process of encrypting data on the device.  This activity should
2538     * be launched after using {@link #setStorageEncryption} to request encryption be activated.
2539     * After resuming from this activity, use {@link #getStorageEncryption}
2540     * to check encryption status.  However, on some devices this activity may never return, as
2541     * it may trigger a reboot and in some cases a complete data wipe of the device.
2542     */
2543    @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
2544    public static final String ACTION_START_ENCRYPTION
2545            = "android.app.action.START_ENCRYPTION";
2546    /**
2547     * Widgets are enabled in keyguard
2548     */
2549    public static final int KEYGUARD_DISABLE_FEATURES_NONE = 0;
2550
2551    /**
2552     * Disable all keyguard widgets. Has no effect.
2553     */
2554    public static final int KEYGUARD_DISABLE_WIDGETS_ALL = 1 << 0;
2555
2556    /**
2557     * Disable the camera on secure keyguard screens (e.g. PIN/Pattern/Password)
2558     */
2559    public static final int KEYGUARD_DISABLE_SECURE_CAMERA = 1 << 1;
2560
2561    /**
2562     * Disable showing all notifications on secure keyguard screens (e.g. PIN/Pattern/Password)
2563     */
2564    public static final int KEYGUARD_DISABLE_SECURE_NOTIFICATIONS = 1 << 2;
2565
2566    /**
2567     * Only allow redacted notifications on secure keyguard screens (e.g. PIN/Pattern/Password)
2568     */
2569    public static final int KEYGUARD_DISABLE_UNREDACTED_NOTIFICATIONS = 1 << 3;
2570
2571    /**
2572     * Ignore trust agent state on secure keyguard screens
2573     * (e.g. PIN/Pattern/Password).
2574     */
2575    public static final int KEYGUARD_DISABLE_TRUST_AGENTS = 1 << 4;
2576
2577    /**
2578     * Disable fingerprint sensor on keyguard secure screens (e.g. PIN/Pattern/Password).
2579     */
2580    public static final int KEYGUARD_DISABLE_FINGERPRINT = 1 << 5;
2581
2582    /**
2583     * Disable text entry into notifications on secure keyguard screens (e.g. PIN/Pattern/Password).
2584     */
2585    public static final int KEYGUARD_DISABLE_REMOTE_INPUT = 1 << 6;
2586
2587    /**
2588     * Disable all current and future keyguard customizations.
2589     */
2590    public static final int KEYGUARD_DISABLE_FEATURES_ALL = 0x7fffffff;
2591
2592    /**
2593     * Called by an application that is administering the device to request that the storage system
2594     * be encrypted.
2595     * <p>
2596     * When multiple device administrators attempt to control device encryption, the most secure,
2597     * supported setting will always be used. If any device administrator requests device
2598     * encryption, it will be enabled; Conversely, if a device administrator attempts to disable
2599     * device encryption while another device administrator has enabled it, the call to disable will
2600     * fail (most commonly returning {@link #ENCRYPTION_STATUS_ACTIVE}).
2601     * <p>
2602     * This policy controls encryption of the secure (application data) storage area. Data written
2603     * to other storage areas may or may not be encrypted, and this policy does not require or
2604     * control the encryption of any other storage areas. There is one exception: If
2605     * {@link android.os.Environment#isExternalStorageEmulated()} is {@code true}, then the
2606     * directory returned by {@link android.os.Environment#getExternalStorageDirectory()} must be
2607     * written to disk within the encrypted storage area.
2608     * <p>
2609     * Important Note: On some devices, it is possible to encrypt storage without requiring the user
2610     * to create a device PIN or Password. In this case, the storage is encrypted, but the
2611     * encryption key may not be fully secured. For maximum security, the administrator should also
2612     * require (and check for) a pattern, PIN, or password.
2613     *
2614     * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
2615     * @param encrypt true to request encryption, false to release any previous request
2616     * @return the new request status (for all active admins) - will be one of
2617     *         {@link #ENCRYPTION_STATUS_UNSUPPORTED}, {@link #ENCRYPTION_STATUS_INACTIVE}, or
2618     *         {@link #ENCRYPTION_STATUS_ACTIVE}. This is the value of the requests; Use
2619     *         {@link #getStorageEncryptionStatus()} to query the actual device state.
2620     * @throws SecurityException if {@code admin} is not an active administrator or does not use
2621     *             {@link DeviceAdminInfo#USES_ENCRYPTED_STORAGE}
2622     */
2623    public int setStorageEncryption(@NonNull ComponentName admin, boolean encrypt) {
2624        throwIfParentInstance("setStorageEncryption");
2625        if (mService != null) {
2626            try {
2627                return mService.setStorageEncryption(admin, encrypt);
2628            } catch (RemoteException e) {
2629                throw e.rethrowFromSystemServer();
2630            }
2631        }
2632        return ENCRYPTION_STATUS_UNSUPPORTED;
2633    }
2634
2635    /**
2636     * Called by an application that is administering the device to
2637     * determine the requested setting for secure storage.
2638     *
2639     * @param admin Which {@link DeviceAdminReceiver} this request is associated with.  If null,
2640     * this will return the requested encryption setting as an aggregate of all active
2641     * administrators.
2642     * @return true if the admin(s) are requesting encryption, false if not.
2643     */
2644    public boolean getStorageEncryption(@Nullable ComponentName admin) {
2645        throwIfParentInstance("getStorageEncryption");
2646        if (mService != null) {
2647            try {
2648                return mService.getStorageEncryption(admin, myUserId());
2649            } catch (RemoteException e) {
2650                throw e.rethrowFromSystemServer();
2651            }
2652        }
2653        return false;
2654    }
2655
2656    /**
2657     * Called by an application that is administering the device to
2658     * determine the current encryption status of the device.
2659     * <p>
2660     * Depending on the returned status code, the caller may proceed in different
2661     * ways.  If the result is {@link #ENCRYPTION_STATUS_UNSUPPORTED}, the
2662     * storage system does not support encryption.  If the
2663     * result is {@link #ENCRYPTION_STATUS_INACTIVE}, use {@link
2664     * #ACTION_START_ENCRYPTION} to begin the process of encrypting or decrypting the
2665     * storage.  If the result is {@link #ENCRYPTION_STATUS_ACTIVE_DEFAULT_KEY}, the
2666     * storage system has enabled encryption but no password is set so further action
2667     * may be required.  If the result is {@link #ENCRYPTION_STATUS_ACTIVATING},
2668     * {@link #ENCRYPTION_STATUS_ACTIVE} or {@link #ENCRYPTION_STATUS_ACTIVE_PER_USER},
2669     * no further action is required.
2670     *
2671     * @return current status of encryption. The value will be one of
2672     * {@link #ENCRYPTION_STATUS_UNSUPPORTED}, {@link #ENCRYPTION_STATUS_INACTIVE},
2673     * {@link #ENCRYPTION_STATUS_ACTIVATING}, {@link #ENCRYPTION_STATUS_ACTIVE_DEFAULT_KEY},
2674     * {@link #ENCRYPTION_STATUS_ACTIVE}, or {@link #ENCRYPTION_STATUS_ACTIVE_PER_USER}.
2675     */
2676    public int getStorageEncryptionStatus() {
2677        throwIfParentInstance("getStorageEncryptionStatus");
2678        return getStorageEncryptionStatus(myUserId());
2679    }
2680
2681    /** @hide per-user version */
2682    public int getStorageEncryptionStatus(int userHandle) {
2683        if (mService != null) {
2684            try {
2685                return mService.getStorageEncryptionStatus(mContext.getPackageName(), userHandle);
2686            } catch (RemoteException e) {
2687                throw e.rethrowFromSystemServer();
2688            }
2689        }
2690        return ENCRYPTION_STATUS_UNSUPPORTED;
2691    }
2692
2693    /**
2694     * Mark a CA certificate as approved by the device user. This means that they have been notified
2695     * of the installation, were made aware of the risks, viewed the certificate and still wanted to
2696     * keep the certificate on the device.
2697     *
2698     * Calling with {@param approval} as {@code true} will cancel any ongoing warnings related to
2699     * this certificate.
2700     *
2701     * @hide
2702     */
2703    public boolean approveCaCert(String alias, int userHandle, boolean approval) {
2704        if (mService != null) {
2705            try {
2706                return mService.approveCaCert(alias, userHandle, approval);
2707            } catch (RemoteException e) {
2708                throw e.rethrowFromSystemServer();
2709            }
2710        }
2711        return false;
2712    }
2713
2714    /**
2715     * Check whether a CA certificate has been approved by the device user.
2716     *
2717     * @hide
2718     */
2719    public boolean isCaCertApproved(String alias, int userHandle) {
2720        if (mService != null) {
2721            try {
2722                return mService.isCaCertApproved(alias, userHandle);
2723            } catch (RemoteException e) {
2724                throw e.rethrowFromSystemServer();
2725            }
2726        }
2727        return false;
2728    }
2729
2730    /**
2731     * Installs the given certificate as a user CA.
2732     *
2733     * @param admin Which {@link DeviceAdminReceiver} this request is associated with, or
2734     *              {@code null} if calling from a delegated certificate installer.
2735     * @param certBuffer encoded form of the certificate to install.
2736     *
2737     * @return false if the certBuffer cannot be parsed or installation is
2738     *         interrupted, true otherwise.
2739     * @throws SecurityException if {@code admin} is not {@code null} and not a device or profile
2740     *         owner.
2741     */
2742    public boolean installCaCert(@Nullable ComponentName admin, byte[] certBuffer) {
2743        throwIfParentInstance("installCaCert");
2744        if (mService != null) {
2745            try {
2746                return mService.installCaCert(admin, certBuffer);
2747            } catch (RemoteException e) {
2748                throw e.rethrowFromSystemServer();
2749            }
2750        }
2751        return false;
2752    }
2753
2754    /**
2755     * Uninstalls the given certificate from trusted user CAs, if present.
2756     *
2757     * @param admin Which {@link DeviceAdminReceiver} this request is associated with, or
2758     *              {@code null} if calling from a delegated certificate installer.
2759     * @param certBuffer encoded form of the certificate to remove.
2760     * @throws SecurityException if {@code admin} is not {@code null} and not a device or profile
2761     *         owner.
2762     */
2763    public void uninstallCaCert(@Nullable ComponentName admin, byte[] certBuffer) {
2764        throwIfParentInstance("uninstallCaCert");
2765        if (mService != null) {
2766            try {
2767                final String alias = getCaCertAlias(certBuffer);
2768                mService.uninstallCaCerts(admin, new String[] {alias});
2769            } catch (CertificateException e) {
2770                Log.w(TAG, "Unable to parse certificate", e);
2771            } catch (RemoteException e) {
2772                throw e.rethrowFromSystemServer();
2773            }
2774        }
2775    }
2776
2777    /**
2778     * Returns all CA certificates that are currently trusted, excluding system CA certificates.
2779     * If a user has installed any certificates by other means than device policy these will be
2780     * included too.
2781     *
2782     * @param admin Which {@link DeviceAdminReceiver} this request is associated with, or
2783     *              {@code null} if calling from a delegated certificate installer.
2784     * @return a List of byte[] arrays, each encoding one user CA certificate.
2785     * @throws SecurityException if {@code admin} is not {@code null} and not a device or profile
2786     *         owner.
2787     */
2788    public List<byte[]> getInstalledCaCerts(@Nullable ComponentName admin) {
2789        List<byte[]> certs = new ArrayList<byte[]>();
2790        throwIfParentInstance("getInstalledCaCerts");
2791        if (mService != null) {
2792            try {
2793                mService.enforceCanManageCaCerts(admin);
2794                final TrustedCertificateStore certStore = new TrustedCertificateStore();
2795                for (String alias : certStore.userAliases()) {
2796                    try {
2797                        certs.add(certStore.getCertificate(alias).getEncoded());
2798                    } catch (CertificateException ce) {
2799                        Log.w(TAG, "Could not encode certificate: " + alias, ce);
2800                    }
2801                }
2802            } catch (RemoteException re) {
2803                throw re.rethrowFromSystemServer();
2804            }
2805        }
2806        return certs;
2807    }
2808
2809    /**
2810     * Uninstalls all custom trusted CA certificates from the profile. Certificates installed by
2811     * means other than device policy will also be removed, except for system CA certificates.
2812     *
2813     * @param admin Which {@link DeviceAdminReceiver} this request is associated with, or
2814     *              {@code null} if calling from a delegated certificate installer.
2815     * @throws SecurityException if {@code admin} is not {@code null} and not a device or profile
2816     *         owner.
2817     */
2818    public void uninstallAllUserCaCerts(@Nullable ComponentName admin) {
2819        throwIfParentInstance("uninstallAllUserCaCerts");
2820        if (mService != null) {
2821            try {
2822                mService.uninstallCaCerts(admin, new TrustedCertificateStore().userAliases()
2823                        .toArray(new String[0]));
2824            } catch (RemoteException re) {
2825                throw re.rethrowFromSystemServer();
2826            }
2827        }
2828    }
2829
2830    /**
2831     * Returns whether this certificate is installed as a trusted CA.
2832     *
2833     * @param admin Which {@link DeviceAdminReceiver} this request is associated with, or
2834     *              {@code null} if calling from a delegated certificate installer.
2835     * @param certBuffer encoded form of the certificate to look up.
2836     * @throws SecurityException if {@code admin} is not {@code null} and not a device or profile
2837     *         owner.
2838     */
2839    public boolean hasCaCertInstalled(@Nullable ComponentName admin, byte[] certBuffer) {
2840        throwIfParentInstance("hasCaCertInstalled");
2841        if (mService != null) {
2842            try {
2843                mService.enforceCanManageCaCerts(admin);
2844                return getCaCertAlias(certBuffer) != null;
2845            } catch (RemoteException re) {
2846                throw re.rethrowFromSystemServer();
2847            } catch (CertificateException ce) {
2848                Log.w(TAG, "Could not parse certificate", ce);
2849            }
2850        }
2851        return false;
2852    }
2853
2854    /**
2855     * Called by a device or profile owner, or delegated certificate installer, to install a
2856     * certificate and corresponding private key. All apps within the profile will be able to access
2857     * the certificate and use the private key, given direct user approval.
2858     *
2859     * <p>Access to the installed credentials will not be granted to the caller of this API without
2860     * direct user approval. This is for security - should a certificate installer become
2861     * compromised, certificates it had already installed will be protected.
2862     *
2863     * <p>If the installer must have access to the credentials, call
2864     * {@link #installKeyPair(ComponentName, PrivateKey, Certificate[], String, boolean)} instead.
2865     *
2866     * @param admin Which {@link DeviceAdminReceiver} this request is associated with, or
2867     *            {@code null} if calling from a delegated certificate installer.
2868     * @param privKey The private key to install.
2869     * @param cert The certificate to install.
2870     * @param alias The private key alias under which to install the certificate. If a certificate
2871     * with that alias already exists, it will be overwritten.
2872     * @return {@code true} if the keys were installed, {@code false} otherwise.
2873     * @throws SecurityException if {@code admin} is not {@code null} and not a device or profile
2874     *         owner.
2875     */
2876    public boolean installKeyPair(@Nullable ComponentName admin, @NonNull PrivateKey privKey,
2877            @NonNull Certificate cert, @NonNull String alias) {
2878        return installKeyPair(admin, privKey, new Certificate[] {cert}, alias, false);
2879    }
2880
2881    /**
2882     * Called by a device or profile owner, or delegated certificate installer, to install a
2883     * certificate chain and corresponding private key for the leaf certificate. All apps within the
2884     * profile will be able to access the certificate chain and use the private key, given direct
2885     * user approval.
2886     *
2887     * <p>The caller of this API may grant itself access to the certificate and private key
2888     * immediately, without user approval. It is a best practice not to request this unless strictly
2889     * necessary since it opens up additional security vulnerabilities.
2890     *
2891     * @param admin Which {@link DeviceAdminReceiver} this request is associated with, or
2892     *        {@code null} if calling from a delegated certificate installer.
2893     * @param privKey The private key to install.
2894     * @param certs The certificate chain to install. The chain should start with the leaf
2895     *        certificate and include the chain of trust in order. This will be returned by
2896     *        {@link android.security.KeyChain#getCertificateChain}.
2897     * @param alias The private key alias under which to install the certificate. If a certificate
2898     *        with that alias already exists, it will be overwritten.
2899     * @param requestAccess {@code true} to request that the calling app be granted access to the
2900     *        credentials immediately. Otherwise, access to the credentials will be gated by user
2901     *        approval.
2902     * @return {@code true} if the keys were installed, {@code false} otherwise.
2903     * @throws SecurityException if {@code admin} is not {@code null} and not a device or profile
2904     *         owner.
2905     * @see android.security.KeyChain#getCertificateChain
2906     */
2907    public boolean installKeyPair(@Nullable ComponentName admin, @NonNull PrivateKey privKey,
2908            @NonNull Certificate[] certs, @NonNull String alias, boolean requestAccess) {
2909        throwIfParentInstance("installKeyPair");
2910        try {
2911            final byte[] pemCert = Credentials.convertToPem(certs[0]);
2912            byte[] pemChain = null;
2913            if (certs.length > 1) {
2914                pemChain = Credentials.convertToPem(Arrays.copyOfRange(certs, 1, certs.length));
2915            }
2916            final byte[] pkcs8Key = KeyFactory.getInstance(privKey.getAlgorithm())
2917                    .getKeySpec(privKey, PKCS8EncodedKeySpec.class).getEncoded();
2918            return mService.installKeyPair(admin, pkcs8Key, pemCert, pemChain, alias,
2919                    requestAccess);
2920        } catch (RemoteException e) {
2921            throw e.rethrowFromSystemServer();
2922        } catch (NoSuchAlgorithmException | InvalidKeySpecException e) {
2923            Log.w(TAG, "Failed to obtain private key material", e);
2924        } catch (CertificateException | IOException e) {
2925            Log.w(TAG, "Could not pem-encode certificate", e);
2926        }
2927        return false;
2928    }
2929
2930    /**
2931     * Called by a device or profile owner, or delegated certificate installer, to remove a
2932     * certificate and private key pair installed under a given alias.
2933     *
2934     * @param admin Which {@link DeviceAdminReceiver} this request is associated with, or
2935     *        {@code null} if calling from a delegated certificate installer.
2936     * @param alias The private key alias under which the certificate is installed.
2937     * @return {@code true} if the private key alias no longer exists, {@code false} otherwise.
2938     * @throws SecurityException if {@code admin} is not {@code null} and not a device or profile
2939     *         owner.
2940     */
2941    public boolean removeKeyPair(@Nullable ComponentName admin, @NonNull String alias) {
2942        throwIfParentInstance("removeKeyPair");
2943        try {
2944            return mService.removeKeyPair(admin, alias);
2945        } catch (RemoteException e) {
2946            throw e.rethrowFromSystemServer();
2947        }
2948    }
2949
2950    /**
2951     * @return the alias of a given CA certificate in the certificate store, or {@code null} if it
2952     * doesn't exist.
2953     */
2954    private static String getCaCertAlias(byte[] certBuffer) throws CertificateException {
2955        final CertificateFactory certFactory = CertificateFactory.getInstance("X.509");
2956        final X509Certificate cert = (X509Certificate) certFactory.generateCertificate(
2957                              new ByteArrayInputStream(certBuffer));
2958        return new TrustedCertificateStore().getCertificateAlias(cert);
2959    }
2960
2961    /**
2962     * Called by a profile owner or device owner to grant access to privileged certificate
2963     * manipulation APIs to a third-party certificate installer app. Granted APIs include
2964     * {@link #getInstalledCaCerts}, {@link #hasCaCertInstalled}, {@link #installCaCert},
2965     * {@link #uninstallCaCert}, {@link #uninstallAllUserCaCerts} and {@link #installKeyPair}.
2966     * <p>
2967     * Delegated certificate installer is a per-user state. The delegated access is persistent until
2968     * it is later cleared by calling this method with a null value or uninstallling the certificate
2969     * installer.
2970     * <p>
2971     * <b>Note:</b>Starting from {@link android.os.Build.VERSION_CODES#N}, if the caller
2972     * application's target SDK version is {@link android.os.Build.VERSION_CODES#N} or newer, the
2973     * supplied certificate installer package must be installed when calling this API, otherwise an
2974     * {@link IllegalArgumentException} will be thrown.
2975     *
2976     * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
2977     * @param installerPackage The package name of the certificate installer which will be given
2978     *            access. If {@code null} is given the current package will be cleared.
2979     * @throws SecurityException if {@code admin} is not a device or a profile owner.
2980     */
2981    public void setCertInstallerPackage(@NonNull ComponentName admin, @Nullable String
2982            installerPackage) throws SecurityException {
2983        throwIfParentInstance("setCertInstallerPackage");
2984        if (mService != null) {
2985            try {
2986                mService.setCertInstallerPackage(admin, installerPackage);
2987            } catch (RemoteException e) {
2988                throw e.rethrowFromSystemServer();
2989            }
2990        }
2991    }
2992
2993    /**
2994     * Called by a profile owner or device owner to retrieve the certificate installer for the user.
2995     * null if none is set.
2996     *
2997     * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
2998     * @return The package name of the current delegated certificate installer, or {@code null} if
2999     *         none is set.
3000     * @throws SecurityException if {@code admin} is not a device or a profile owner.
3001     */
3002    public String getCertInstallerPackage(@NonNull ComponentName admin) throws SecurityException {
3003        throwIfParentInstance("getCertInstallerPackage");
3004        if (mService != null) {
3005            try {
3006                return mService.getCertInstallerPackage(admin);
3007            } catch (RemoteException e) {
3008                throw e.rethrowFromSystemServer();
3009            }
3010        }
3011        return null;
3012    }
3013
3014    /**
3015     * Called by a device or profile owner to configure an always-on VPN connection through a
3016     * specific application for the current user.
3017     *
3018     * @deprecated this version only exists for compability with previous developer preview builds.
3019     *             TODO: delete once there are no longer any live references.
3020     * @hide
3021     */
3022    public void setAlwaysOnVpnPackage(@NonNull ComponentName admin, @Nullable String vpnPackage)
3023            throws NameNotFoundException, UnsupportedOperationException {
3024        setAlwaysOnVpnPackage(admin, vpnPackage, /* lockdownEnabled */ true);
3025    }
3026
3027    /**
3028     * Called by a device or profile owner to configure an always-on VPN connection through a
3029     * specific application for the current user. This connection is automatically granted and
3030     * persisted after a reboot.
3031     * <p>
3032     * The designated package should declare a {@link android.net.VpnService} in its manifest
3033     * guarded by {@link android.Manifest.permission#BIND_VPN_SERVICE}, otherwise the call will
3034     * fail.
3035     *
3036     * @param vpnPackage The package name for an installed VPN app on the device, or {@code null} to
3037     *        remove an existing always-on VPN configuration.
3038     * @param lockdownEnabled {@code true} to disallow networking when the VPN is not connected or
3039     *        {@code false} otherwise. This carries the risk that any failure of the VPN provider
3040     *        could break networking for all apps. This has no effect when clearing.
3041     * @throws SecurityException if {@code admin} is not a device or a profile owner.
3042     * @throws NameNotFoundException if {@code vpnPackage} is not installed.
3043     * @throws UnsupportedOperationException if {@code vpnPackage} exists but does not support being
3044     *         set as always-on, or if always-on VPN is not available.
3045     */
3046    public void setAlwaysOnVpnPackage(@NonNull ComponentName admin, @Nullable String vpnPackage,
3047            boolean lockdownEnabled)
3048            throws NameNotFoundException, UnsupportedOperationException {
3049        throwIfParentInstance("setAlwaysOnVpnPackage");
3050        if (mService != null) {
3051            try {
3052                if (!mService.setAlwaysOnVpnPackage(admin, vpnPackage, lockdownEnabled)) {
3053                    throw new NameNotFoundException(vpnPackage);
3054                }
3055            } catch (RemoteException e) {
3056                throw e.rethrowFromSystemServer();
3057            }
3058        }
3059    }
3060
3061    /**
3062     * Called by a device or profile owner to read the name of the package administering an
3063     * always-on VPN connection for the current user. If there is no such package, or the always-on
3064     * VPN is provided by the system instead of by an application, {@code null} will be returned.
3065     *
3066     * @return Package name of VPN controller responsible for always-on VPN, or {@code null} if none
3067     *         is set.
3068     * @throws SecurityException if {@code admin} is not a device or a profile owner.
3069     */
3070    public String getAlwaysOnVpnPackage(@NonNull ComponentName admin) {
3071        throwIfParentInstance("getAlwaysOnVpnPackage");
3072        if (mService != null) {
3073            try {
3074                return mService.getAlwaysOnVpnPackage(admin);
3075            } catch (RemoteException e) {
3076                throw e.rethrowFromSystemServer();
3077            }
3078        }
3079        return null;
3080    }
3081
3082    /**
3083     * Called by an application that is administering the device to disable all cameras on the
3084     * device, for this user. After setting this, no applications running as this user will be able
3085     * to access any cameras on the device.
3086     * <p>
3087     * If the caller is device owner, then the restriction will be applied to all users.
3088     * <p>
3089     * The calling device admin must have requested
3090     * {@link DeviceAdminInfo#USES_POLICY_DISABLE_CAMERA} to be able to call this method; if it has
3091     * not, a security exception will be thrown.
3092     *
3093     * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
3094     * @param disabled Whether or not the camera should be disabled.
3095     * @throws SecurityException if {@code admin} is not an active administrator or does not use
3096     *             {@link DeviceAdminInfo#USES_POLICY_DISABLE_CAMERA}.
3097     */
3098    public void setCameraDisabled(@NonNull ComponentName admin, boolean disabled) {
3099        throwIfParentInstance("setCameraDisabled");
3100        if (mService != null) {
3101            try {
3102                mService.setCameraDisabled(admin, disabled);
3103            } catch (RemoteException e) {
3104                throw e.rethrowFromSystemServer();
3105            }
3106        }
3107    }
3108
3109    /**
3110     * Determine whether or not the device's cameras have been disabled for this user,
3111     * either by the calling admin, if specified, or all admins.
3112     * @param admin The name of the admin component to check, or {@code null} to check whether any admins
3113     * have disabled the camera
3114     */
3115    public boolean getCameraDisabled(@Nullable ComponentName admin) {
3116        throwIfParentInstance("getCameraDisabled");
3117        return getCameraDisabled(admin, myUserId());
3118    }
3119
3120    /** @hide per-user version */
3121    public boolean getCameraDisabled(@Nullable ComponentName admin, int userHandle) {
3122        if (mService != null) {
3123            try {
3124                return mService.getCameraDisabled(admin, userHandle);
3125            } catch (RemoteException e) {
3126                throw e.rethrowFromSystemServer();
3127            }
3128        }
3129        return false;
3130    }
3131
3132    /**
3133     * Called by a device owner to request a bugreport.
3134     * <p>
3135     * There must be only one user on the device, managed by the device owner. Otherwise a
3136     * {@link SecurityException} will be thrown.
3137     *
3138     * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
3139     * @return {@code true} if the bugreport collection started successfully, or {@code false} if it
3140     *         wasn't triggered because a previous bugreport operation is still active (either the
3141     *         bugreport is still running or waiting for the user to share or decline)
3142     * @throws SecurityException if {@code admin} is not a device owner, or if there are users other
3143     *             than the one managed by the device owner.
3144     */
3145    public boolean requestBugreport(@NonNull ComponentName admin) {
3146        throwIfParentInstance("requestBugreport");
3147        if (mService != null) {
3148            try {
3149                return mService.requestBugreport(admin);
3150            } catch (RemoteException e) {
3151                throw e.rethrowFromSystemServer();
3152            }
3153        }
3154        return false;
3155    }
3156
3157    /**
3158     * Determine whether or not creating a guest user has been disabled for the device
3159     *
3160     * @hide
3161     */
3162    public boolean getGuestUserDisabled(@Nullable ComponentName admin) {
3163        // Currently guest users can always be created if multi-user is enabled
3164        // TODO introduce a policy for guest user creation
3165        return false;
3166    }
3167
3168    /**
3169     * Called by a device/profile owner to set whether the screen capture is disabled. Disabling
3170     * screen capture also prevents the content from being shown on display devices that do not have
3171     * a secure video output. See {@link android.view.Display#FLAG_SECURE} for more details about
3172     * secure surfaces and secure displays.
3173     * <p>
3174     * The calling device admin must be a device or profile owner. If it is not, a security
3175     * exception will be thrown.
3176     * <p>
3177     * From version {@link android.os.Build.VERSION_CODES#M} disabling screen capture also blocks
3178     * assist requests for all activities of the relevant user.
3179     *
3180     * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
3181     * @param disabled Whether screen capture is disabled or not.
3182     * @throws SecurityException if {@code admin} is not a device or profile owner.
3183     */
3184    public void setScreenCaptureDisabled(@NonNull ComponentName admin, boolean disabled) {
3185        throwIfParentInstance("setScreenCaptureDisabled");
3186        if (mService != null) {
3187            try {
3188                mService.setScreenCaptureDisabled(admin, disabled);
3189            } catch (RemoteException e) {
3190                throw e.rethrowFromSystemServer();
3191            }
3192        }
3193    }
3194
3195    /**
3196     * Determine whether or not screen capture has been disabled by the calling
3197     * admin, if specified, or all admins.
3198     * @param admin The name of the admin component to check, or {@code null} to check whether any admins
3199     * have disabled screen capture.
3200     */
3201    public boolean getScreenCaptureDisabled(@Nullable ComponentName admin) {
3202        throwIfParentInstance("getScreenCaptureDisabled");
3203        return getScreenCaptureDisabled(admin, myUserId());
3204    }
3205
3206    /** @hide per-user version */
3207    public boolean getScreenCaptureDisabled(@Nullable ComponentName admin, int userHandle) {
3208        if (mService != null) {
3209            try {
3210                return mService.getScreenCaptureDisabled(admin, userHandle);
3211            } catch (RemoteException e) {
3212                throw e.rethrowFromSystemServer();
3213            }
3214        }
3215        return false;
3216    }
3217
3218    /**
3219     * Called by a device owner to set whether auto time is required. If auto time is required the
3220     * user cannot set the date and time, but has to use network date and time.
3221     * <p>
3222     * Note: if auto time is required the user can still manually set the time zone.
3223     * <p>
3224     * The calling device admin must be a device owner. If it is not, a security exception will be
3225     * thrown.
3226     *
3227     * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
3228     * @param required Whether auto time is set required or not.
3229     * @throws SecurityException if {@code admin} is not a device owner.
3230     */
3231    public void setAutoTimeRequired(@NonNull ComponentName admin, boolean required) {
3232        throwIfParentInstance("setAutoTimeRequired");
3233        if (mService != null) {
3234            try {
3235                mService.setAutoTimeRequired(admin, required);
3236            } catch (RemoteException e) {
3237                throw e.rethrowFromSystemServer();
3238            }
3239        }
3240    }
3241
3242    /**
3243     * @return true if auto time is required.
3244     */
3245    public boolean getAutoTimeRequired() {
3246        throwIfParentInstance("getAutoTimeRequired");
3247        if (mService != null) {
3248            try {
3249                return mService.getAutoTimeRequired();
3250            } catch (RemoteException e) {
3251                throw e.rethrowFromSystemServer();
3252            }
3253        }
3254        return false;
3255    }
3256
3257    /**
3258     * Called by a device owner to set whether all users created on the device should be ephemeral.
3259     * <p>
3260     * The system user is exempt from this policy - it is never ephemeral.
3261     * <p>
3262     * The calling device admin must be the device owner. If it is not, a security exception will be
3263     * thrown.
3264     *
3265     * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
3266     * @param forceEphemeralUsers If true, all the existing users will be deleted and all
3267     *            subsequently created users will be ephemeral.
3268     * @throws SecurityException if {@code admin} is not a device owner.
3269     * @hide
3270     */
3271    public void setForceEphemeralUsers(
3272            @NonNull ComponentName admin, boolean forceEphemeralUsers) {
3273        throwIfParentInstance("setForceEphemeralUsers");
3274        if (mService != null) {
3275            try {
3276                mService.setForceEphemeralUsers(admin, forceEphemeralUsers);
3277            } catch (RemoteException e) {
3278                throw e.rethrowFromSystemServer();
3279            }
3280        }
3281    }
3282
3283    /**
3284     * @return true if all users are created ephemeral.
3285     * @throws SecurityException if {@code admin} is not a device owner.
3286     * @hide
3287     */
3288    public boolean getForceEphemeralUsers(@NonNull ComponentName admin) {
3289        throwIfParentInstance("getForceEphemeralUsers");
3290        if (mService != null) {
3291            try {
3292                return mService.getForceEphemeralUsers(admin);
3293            } catch (RemoteException e) {
3294                throw e.rethrowFromSystemServer();
3295            }
3296        }
3297        return false;
3298    }
3299
3300    /**
3301     * Called by an application that is administering the device to disable keyguard customizations,
3302     * such as widgets. After setting this, keyguard features will be disabled according to the
3303     * provided feature list.
3304     * <p>
3305     * The calling device admin must have requested
3306     * {@link DeviceAdminInfo#USES_POLICY_DISABLE_KEYGUARD_FEATURES} to be able to call this method;
3307     * if it has not, a security exception will be thrown.
3308     * <p>
3309     * Calling this from a managed profile before version {@link android.os.Build.VERSION_CODES#M}
3310     * will throw a security exception. From version {@link android.os.Build.VERSION_CODES#M} the
3311     * profile owner of a managed profile can set:
3312     * <ul>
3313     * <li>{@link #KEYGUARD_DISABLE_TRUST_AGENTS}, which affects the parent user, but only if there
3314     * is no separate challenge set on the managed profile.
3315     * <li>{@link #KEYGUARD_DISABLE_FINGERPRINT} which affects the managed profile challenge if
3316     * there is one, or the parent user otherwise.
3317     * <li>{@link #KEYGUARD_DISABLE_UNREDACTED_NOTIFICATIONS} which affects notifications generated
3318     * by applications in the managed profile.
3319     * </ul>
3320     * {@link #KEYGUARD_DISABLE_TRUST_AGENTS} and {@link #KEYGUARD_DISABLE_FINGERPRINT} can also be
3321     * set on the {@link DevicePolicyManager} instance returned by
3322     * {@link #getParentProfileInstance(ComponentName)} in order to set restrictions on the parent
3323     * profile.
3324     * <p>
3325     * Requests to disable other features on a managed profile will be ignored.
3326     * <p>
3327     * The admin can check which features have been disabled by calling
3328     * {@link #getKeyguardDisabledFeatures(ComponentName)}
3329     *
3330     * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
3331     * @param which {@link #KEYGUARD_DISABLE_FEATURES_NONE} (default),
3332     *            {@link #KEYGUARD_DISABLE_WIDGETS_ALL}, {@link #KEYGUARD_DISABLE_SECURE_CAMERA},
3333     *            {@link #KEYGUARD_DISABLE_SECURE_NOTIFICATIONS},
3334     *            {@link #KEYGUARD_DISABLE_TRUST_AGENTS},
3335     *            {@link #KEYGUARD_DISABLE_UNREDACTED_NOTIFICATIONS},
3336     *            {@link #KEYGUARD_DISABLE_FINGERPRINT}, {@link #KEYGUARD_DISABLE_FEATURES_ALL}
3337     * @throws SecurityException if {@code admin} is not an active administrator or does not user
3338     *             {@link DeviceAdminInfo#USES_POLICY_DISABLE_KEYGUARD_FEATURES}
3339     */
3340    public void setKeyguardDisabledFeatures(@NonNull ComponentName admin, int which) {
3341        if (mService != null) {
3342            try {
3343                mService.setKeyguardDisabledFeatures(admin, which, mParentInstance);
3344            } catch (RemoteException e) {
3345                throw e.rethrowFromSystemServer();
3346            }
3347        }
3348    }
3349
3350    /**
3351     * Determine whether or not features have been disabled in keyguard either by the calling
3352     * admin, if specified, or all admins that set restrictions on this user and its participating
3353     * profiles. Restrictions on profiles that have a separate challenge are not taken into account.
3354     *
3355     * <p>This method can be called on the {@link DevicePolicyManager} instance
3356     * returned by {@link #getParentProfileInstance(ComponentName)} in order to retrieve
3357     * restrictions on the parent profile.
3358     *
3359     * @param admin The name of the admin component to check, or {@code null} to check whether any
3360     * admins have disabled features in keyguard.
3361     * @return bitfield of flags. See {@link #setKeyguardDisabledFeatures(ComponentName, int)}
3362     * for a list.
3363     */
3364    public int getKeyguardDisabledFeatures(@Nullable ComponentName admin) {
3365        return getKeyguardDisabledFeatures(admin, myUserId());
3366    }
3367
3368    /** @hide per-user version */
3369    public int getKeyguardDisabledFeatures(@Nullable ComponentName admin, int userHandle) {
3370        if (mService != null) {
3371            try {
3372                return mService.getKeyguardDisabledFeatures(admin, userHandle, mParentInstance);
3373            } catch (RemoteException e) {
3374                throw e.rethrowFromSystemServer();
3375            }
3376        }
3377        return KEYGUARD_DISABLE_FEATURES_NONE;
3378    }
3379
3380    /**
3381     * @hide
3382     */
3383    public void setActiveAdmin(@NonNull ComponentName policyReceiver, boolean refreshing,
3384            int userHandle) {
3385        if (mService != null) {
3386            try {
3387                mService.setActiveAdmin(policyReceiver, refreshing, userHandle);
3388            } catch (RemoteException e) {
3389                throw e.rethrowFromSystemServer();
3390            }
3391        }
3392    }
3393
3394    /**
3395     * @hide
3396     */
3397    public void setActiveAdmin(@NonNull ComponentName policyReceiver, boolean refreshing) {
3398        setActiveAdmin(policyReceiver, refreshing, myUserId());
3399    }
3400
3401    /**
3402     * @hide
3403     */
3404    public void getRemoveWarning(@Nullable ComponentName admin, RemoteCallback result) {
3405        if (mService != null) {
3406            try {
3407                mService.getRemoveWarning(admin, result, myUserId());
3408            } catch (RemoteException e) {
3409                throw e.rethrowFromSystemServer();
3410            }
3411        }
3412    }
3413
3414    /**
3415     * @hide
3416     */
3417    public void setActivePasswordState(int quality, int length, int letters, int uppercase,
3418            int lowercase, int numbers, int symbols, int nonletter, int userHandle) {
3419        if (mService != null) {
3420            try {
3421                mService.setActivePasswordState(quality, length, letters, uppercase, lowercase,
3422                        numbers, symbols, nonletter, userHandle);
3423            } catch (RemoteException e) {
3424                throw e.rethrowFromSystemServer();
3425            }
3426        }
3427    }
3428
3429    /**
3430     * @hide
3431     */
3432    public void reportFailedPasswordAttempt(int userHandle) {
3433        if (mService != null) {
3434            try {
3435                mService.reportFailedPasswordAttempt(userHandle);
3436            } catch (RemoteException e) {
3437                throw e.rethrowFromSystemServer();
3438            }
3439        }
3440    }
3441
3442    /**
3443     * @hide
3444     */
3445    public void reportSuccessfulPasswordAttempt(int userHandle) {
3446        if (mService != null) {
3447            try {
3448                mService.reportSuccessfulPasswordAttempt(userHandle);
3449            } catch (RemoteException e) {
3450                throw e.rethrowFromSystemServer();
3451            }
3452        }
3453    }
3454
3455    /**
3456     * @hide
3457     */
3458    public void reportFailedFingerprintAttempt(int userHandle) {
3459        if (mService != null) {
3460            try {
3461                mService.reportFailedFingerprintAttempt(userHandle);
3462            } catch (RemoteException e) {
3463                throw e.rethrowFromSystemServer();
3464            }
3465        }
3466    }
3467
3468    /**
3469     * @hide
3470     */
3471    public void reportSuccessfulFingerprintAttempt(int userHandle) {
3472        if (mService != null) {
3473            try {
3474                mService.reportSuccessfulFingerprintAttempt(userHandle);
3475            } catch (RemoteException e) {
3476                throw e.rethrowFromSystemServer();
3477            }
3478        }
3479    }
3480
3481    /**
3482     * Should be called when keyguard has been dismissed.
3483     * @hide
3484     */
3485    public void reportKeyguardDismissed(int userHandle) {
3486        if (mService != null) {
3487            try {
3488                mService.reportKeyguardDismissed(userHandle);
3489            } catch (RemoteException e) {
3490                throw e.rethrowFromSystemServer();
3491            }
3492        }
3493    }
3494
3495    /**
3496     * Should be called when keyguard view has been shown to the user.
3497     * @hide
3498     */
3499    public void reportKeyguardSecured(int userHandle) {
3500        if (mService != null) {
3501            try {
3502                mService.reportKeyguardSecured(userHandle);
3503            } catch (RemoteException e) {
3504                throw e.rethrowFromSystemServer();
3505            }
3506        }
3507    }
3508
3509    /**
3510     * @hide
3511     * Sets the given package as the device owner.
3512     * Same as {@link #setDeviceOwner(ComponentName, String)} but without setting a device owner name.
3513     * @param who the component name to be registered as device owner.
3514     * @return whether the package was successfully registered as the device owner.
3515     * @throws IllegalArgumentException if the package name is null or invalid
3516     * @throws IllegalStateException If the preconditions mentioned are not met.
3517     */
3518    public boolean setDeviceOwner(ComponentName who) {
3519        return setDeviceOwner(who, null);
3520    }
3521
3522    /**
3523     * @hide
3524     */
3525    public boolean setDeviceOwner(ComponentName who, int userId)  {
3526        return setDeviceOwner(who, null, userId);
3527    }
3528
3529    /**
3530     * @hide
3531     */
3532    public boolean setDeviceOwner(ComponentName who, String ownerName) {
3533        return setDeviceOwner(who, ownerName, UserHandle.USER_SYSTEM);
3534    }
3535
3536    /**
3537     * @hide
3538     * Sets the given package as the device owner. The package must already be installed. There
3539     * must not already be a device owner.
3540     * Only apps with the MANAGE_PROFILE_AND_DEVICE_OWNERS permission and the shell uid can call
3541     * this method.
3542     * Calling this after the setup phase of the primary user has completed is allowed only if
3543     * the caller is the shell uid, and there are no additional users and no accounts.
3544     * @param who the component name to be registered as device owner.
3545     * @param ownerName the human readable name of the institution that owns this device.
3546     * @param userId ID of the user on which the device owner runs.
3547     * @return whether the package was successfully registered as the device owner.
3548     * @throws IllegalArgumentException if the package name is null or invalid
3549     * @throws IllegalStateException If the preconditions mentioned are not met.
3550     */
3551    public boolean setDeviceOwner(ComponentName who, String ownerName, int userId)
3552            throws IllegalArgumentException, IllegalStateException {
3553        if (mService != null) {
3554            try {
3555                return mService.setDeviceOwner(who, ownerName, userId);
3556            } catch (RemoteException re) {
3557                throw re.rethrowFromSystemServer();
3558            }
3559        }
3560        return false;
3561    }
3562
3563    /**
3564     * Used to determine if a particular package has been registered as a Device Owner app.
3565     * A device owner app is a special device admin that cannot be deactivated by the user, once
3566     * activated as a device admin. It also cannot be uninstalled. To check whether a particular
3567     * package is currently registered as the device owner app, pass in the package name from
3568     * {@link Context#getPackageName()} to this method.<p/>This is useful for device
3569     * admin apps that want to check whether they are also registered as the device owner app. The
3570     * exact mechanism by which a device admin app is registered as a device owner app is defined by
3571     * the setup process.
3572     * @param packageName the package name of the app, to compare with the registered device owner
3573     * app, if any.
3574     * @return whether or not the package is registered as the device owner app.
3575     */
3576    public boolean isDeviceOwnerApp(String packageName) {
3577        throwIfParentInstance("isDeviceOwnerApp");
3578        return isDeviceOwnerAppOnCallingUser(packageName);
3579    }
3580
3581    /**
3582     * @return true if a package is registered as device owner, only when it's running on the
3583     * calling user.
3584     *
3585     * <p>Same as {@link #isDeviceOwnerApp}, but bundled code should use it for clarity.
3586     * @hide
3587     */
3588    public boolean isDeviceOwnerAppOnCallingUser(String packageName) {
3589        return isDeviceOwnerAppOnAnyUserInner(packageName, /* callingUserOnly =*/ true);
3590    }
3591
3592    /**
3593     * @return true if a package is registered as device owner, even if it's running on a different
3594     * user.
3595     *
3596     * <p>Requires the MANAGE_USERS permission.
3597     *
3598     * @hide
3599     */
3600    public boolean isDeviceOwnerAppOnAnyUser(String packageName) {
3601        return isDeviceOwnerAppOnAnyUserInner(packageName, /* callingUserOnly =*/ false);
3602    }
3603
3604    /**
3605     * @return device owner component name, only when it's running on the calling user.
3606     *
3607     * @hide
3608     */
3609    public ComponentName getDeviceOwnerComponentOnCallingUser() {
3610        return getDeviceOwnerComponentInner(/* callingUserOnly =*/ true);
3611    }
3612
3613    /**
3614     * @return device owner component name, even if it's running on a different user.
3615     *
3616     * <p>Requires the MANAGE_USERS permission.
3617     *
3618     * @hide
3619     */
3620    public ComponentName getDeviceOwnerComponentOnAnyUser() {
3621        return getDeviceOwnerComponentInner(/* callingUserOnly =*/ false);
3622    }
3623
3624    private boolean isDeviceOwnerAppOnAnyUserInner(String packageName, boolean callingUserOnly) {
3625        if (packageName == null) {
3626            return false;
3627        }
3628        final ComponentName deviceOwner = getDeviceOwnerComponentInner(callingUserOnly);
3629        if (deviceOwner == null) {
3630            return false;
3631        }
3632        return packageName.equals(deviceOwner.getPackageName());
3633    }
3634
3635    private ComponentName getDeviceOwnerComponentInner(boolean callingUserOnly) {
3636        if (mService != null) {
3637            try {
3638                return mService.getDeviceOwnerComponent(callingUserOnly);
3639            } catch (RemoteException re) {
3640                throw re.rethrowFromSystemServer();
3641            }
3642        }
3643        return null;
3644    }
3645
3646    /**
3647     * @return ID of the user who runs device owner, or {@link UserHandle#USER_NULL} if there's
3648     * no device owner.
3649     *
3650     * <p>Requires the MANAGE_USERS permission.
3651     *
3652     * @hide
3653     */
3654    public int getDeviceOwnerUserId() {
3655        if (mService != null) {
3656            try {
3657                return mService.getDeviceOwnerUserId();
3658            } catch (RemoteException re) {
3659                throw re.rethrowFromSystemServer();
3660            }
3661        }
3662        return UserHandle.USER_NULL;
3663    }
3664
3665    /**
3666     * Clears the current device owner. The caller must be the device owner. This function should be
3667     * used cautiously as once it is called it cannot be undone. The device owner can only be set as
3668     * a part of device setup before setup completes.
3669     *
3670     * @param packageName The package name of the device owner.
3671     * @throws SecurityException if the caller is not in {@code packageName} or {@code packageName}
3672     *             does not own the current device owner component.
3673     */
3674    public void clearDeviceOwnerApp(String packageName) {
3675        throwIfParentInstance("clearDeviceOwnerApp");
3676        if (mService != null) {
3677            try {
3678                mService.clearDeviceOwner(packageName);
3679            } catch (RemoteException re) {
3680                throw re.rethrowFromSystemServer();
3681            }
3682        }
3683    }
3684
3685    /**
3686     * Returns the device owner package name, only if it's running on the calling user.
3687     *
3688     * <p>Bundled components should use {@code getDeviceOwnerComponentOnCallingUser()} for clarity.
3689     *
3690     * @hide
3691     */
3692    @SystemApi
3693    public String getDeviceOwner() {
3694        throwIfParentInstance("getDeviceOwner");
3695        final ComponentName name = getDeviceOwnerComponentOnCallingUser();
3696        return name != null ? name.getPackageName() : null;
3697    }
3698
3699    /**
3700     * @return true if the device is managed by any device owner.
3701     *
3702     * <p>Requires the MANAGE_USERS permission.
3703     *
3704     * @hide
3705     */
3706    public boolean isDeviceManaged() {
3707        return getDeviceOwnerComponentOnAnyUser() != null;
3708    }
3709
3710    /**
3711     * Returns the device owner name.  Note this method *will* return the device owner
3712     * name when it's running on a different user.
3713     *
3714     * <p>Requires the MANAGE_USERS permission.
3715     *
3716     * @hide
3717     */
3718    @SystemApi
3719    public String getDeviceOwnerNameOnAnyUser() {
3720        throwIfParentInstance("getDeviceOwnerNameOnAnyUser");
3721        if (mService != null) {
3722            try {
3723                return mService.getDeviceOwnerName();
3724            } catch (RemoteException re) {
3725                throw re.rethrowFromSystemServer();
3726            }
3727        }
3728        return null;
3729    }
3730
3731    /**
3732     * @hide
3733     * @deprecated Do not use
3734     * @removed
3735     */
3736    @Deprecated
3737    @SystemApi
3738    public String getDeviceInitializerApp() {
3739        return null;
3740    }
3741
3742    /**
3743     * @hide
3744     * @deprecated Do not use
3745     * @removed
3746     */
3747    @Deprecated
3748    @SystemApi
3749    public ComponentName getDeviceInitializerComponent() {
3750        return null;
3751    }
3752
3753    /**
3754     * @hide
3755     * @deprecated Use #ACTION_SET_PROFILE_OWNER
3756     * Sets the given component as an active admin and registers the package as the profile
3757     * owner for this user. The package must already be installed and there shouldn't be
3758     * an existing profile owner registered for this user. Also, this method must be called
3759     * before the user setup has been completed.
3760     * <p>
3761     * This method can only be called by system apps that hold MANAGE_USERS permission and
3762     * MANAGE_DEVICE_ADMINS permission.
3763     * @param admin The component to register as an active admin and profile owner.
3764     * @param ownerName The user-visible name of the entity that is managing this user.
3765     * @return whether the admin was successfully registered as the profile owner.
3766     * @throws IllegalArgumentException if packageName is null, the package isn't installed, or
3767     *         the user has already been set up.
3768     */
3769    @SystemApi
3770    public boolean setActiveProfileOwner(@NonNull ComponentName admin, @Deprecated String ownerName)
3771            throws IllegalArgumentException {
3772        throwIfParentInstance("setActiveProfileOwner");
3773        if (mService != null) {
3774            try {
3775                final int myUserId = myUserId();
3776                mService.setActiveAdmin(admin, false, myUserId);
3777                return mService.setProfileOwner(admin, ownerName, myUserId);
3778            } catch (RemoteException re) {
3779                throw re.rethrowFromSystemServer();
3780            }
3781        }
3782        return false;
3783    }
3784
3785    /**
3786     * Clears the active profile owner and removes all user restrictions. The caller must be from
3787     * the same package as the active profile owner for this user, otherwise a SecurityException
3788     * will be thrown.
3789     * <p>
3790     * This doesn't work for managed profile owners.
3791     *
3792     * @param admin The component to remove as the profile owner.
3793     * @throws SecurityException if {@code admin} is not an active profile owner.
3794     */
3795    public void clearProfileOwner(@NonNull ComponentName admin) {
3796        throwIfParentInstance("clearProfileOwner");
3797        if (mService != null) {
3798            try {
3799                mService.clearProfileOwner(admin);
3800            } catch (RemoteException re) {
3801                throw re.rethrowFromSystemServer();
3802            }
3803        }
3804    }
3805
3806    /**
3807     * @hide
3808     * Checks whether the user was already setup.
3809     */
3810    public boolean hasUserSetupCompleted() {
3811        if (mService != null) {
3812            try {
3813                return mService.hasUserSetupCompleted();
3814            } catch (RemoteException re) {
3815                throw re.rethrowFromSystemServer();
3816            }
3817        }
3818        return true;
3819    }
3820
3821    /**
3822     * @hide
3823     * Sets the given component as the profile owner of the given user profile. The package must
3824     * already be installed. There must not already be a profile owner for this user.
3825     * Only apps with the MANAGE_PROFILE_AND_DEVICE_OWNERS permission and the shell uid can call
3826     * this method.
3827     * Calling this after the setup phase of the specified user has completed is allowed only if:
3828     * - the caller is SYSTEM_UID.
3829     * - or the caller is the shell uid, and there are no accounts on the specified user.
3830     * @param admin the component name to be registered as profile owner.
3831     * @param ownerName the human readable name of the organisation associated with this DPM.
3832     * @param userHandle the userId to set the profile owner for.
3833     * @return whether the component was successfully registered as the profile owner.
3834     * @throws IllegalArgumentException if admin is null, the package isn't installed, or the
3835     * preconditions mentioned are not met.
3836     */
3837    public boolean setProfileOwner(@NonNull ComponentName admin, @Deprecated String ownerName,
3838            int userHandle) throws IllegalArgumentException {
3839        if (mService != null) {
3840            try {
3841                if (ownerName == null) {
3842                    ownerName = "";
3843                }
3844                return mService.setProfileOwner(admin, ownerName, userHandle);
3845            } catch (RemoteException re) {
3846                throw re.rethrowFromSystemServer();
3847            }
3848        }
3849        return false;
3850    }
3851
3852    /**
3853     * Sets the device owner information to be shown on the lock screen.
3854     * <p>
3855     * If the device owner information is {@code null} or empty then the device owner info is
3856     * cleared and the user owner info is shown on the lock screen if it is set.
3857     * <p>
3858     * If the device owner information contains only whitespaces then the message on the lock screen
3859     * will be blank and the user will not be allowed to change it.
3860     * <p>
3861     * If the device owner information needs to be localized, it is the responsibility of the
3862     * {@link DeviceAdminReceiver} to listen to the {@link Intent#ACTION_LOCALE_CHANGED} broadcast
3863     * and set a new version of this string accordingly.
3864     *
3865     * @param admin The name of the admin component to check.
3866     * @param info Device owner information which will be displayed instead of the user owner info.
3867     * @throws SecurityException if {@code admin} is not a device owner.
3868     */
3869    public void setDeviceOwnerLockScreenInfo(@NonNull ComponentName admin, CharSequence info) {
3870        throwIfParentInstance("setDeviceOwnerLockScreenInfo");
3871        if (mService != null) {
3872            try {
3873                mService.setDeviceOwnerLockScreenInfo(admin, info);
3874            } catch (RemoteException re) {
3875                throw re.rethrowFromSystemServer();
3876            }
3877        }
3878    }
3879
3880    /**
3881     * @return The device owner information. If it is not set returns {@code null}.
3882     */
3883    public CharSequence getDeviceOwnerLockScreenInfo() {
3884        throwIfParentInstance("getDeviceOwnerLockScreenInfo");
3885        if (mService != null) {
3886            try {
3887                return mService.getDeviceOwnerLockScreenInfo();
3888            } catch (RemoteException re) {
3889                throw re.rethrowFromSystemServer();
3890            }
3891        }
3892        return null;
3893    }
3894
3895    /**
3896     * Called by device or profile owners to suspend packages for this user.
3897     * <p>
3898     * A suspended package will not be able to start activities. Its notifications will be hidden,
3899     * it will not show up in recents, will not be able to show toasts or dialogs or ring the
3900     * device.
3901     * <p>
3902     * The package must already be installed. If the package is uninstalled while suspended the
3903     * package will no longer be suspended. The admin can block this by using
3904     * {@link #setUninstallBlocked}.
3905     *
3906     * @param admin The name of the admin component to check.
3907     * @param packageNames The package names to suspend or unsuspend.
3908     * @param suspended If set to {@code true} than the packages will be suspended, if set to
3909     *            {@code false} the packages will be unsuspended.
3910     * @return an array of package names for which the suspended status is not set as requested in
3911     *         this method.
3912     * @throws SecurityException if {@code admin} is not a device or profile owner.
3913     */
3914    public String[] setPackagesSuspended(@NonNull ComponentName admin, String[] packageNames,
3915            boolean suspended) {
3916        throwIfParentInstance("setPackagesSuspended");
3917        if (mService != null) {
3918            try {
3919                return mService.setPackagesSuspended(admin, packageNames, suspended);
3920            } catch (RemoteException re) {
3921                throw re.rethrowFromSystemServer();
3922            }
3923        }
3924        return packageNames;
3925    }
3926
3927    /**
3928     * Called by device or profile owners to determine if a package is suspended.
3929     *
3930     * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
3931     * @param packageName The name of the package to retrieve the suspended status of.
3932     * @return {@code true} if the package is suspended or {@code false} if the package is not
3933     *         suspended, could not be found or an error occurred.
3934     * @throws SecurityException if {@code admin} is not a device or profile owner.
3935     * @throws NameNotFoundException if the package could not be found.
3936     */
3937    public boolean isPackageSuspended(@NonNull ComponentName admin, String packageName)
3938            throws NameNotFoundException {
3939        throwIfParentInstance("isPackageSuspended");
3940        if (mService != null) {
3941            try {
3942                return mService.isPackageSuspended(admin, packageName);
3943            } catch (RemoteException e) {
3944                throw e.rethrowFromSystemServer();
3945            } catch (IllegalArgumentException ex) {
3946                throw new NameNotFoundException(packageName);
3947            }
3948        }
3949        return false;
3950    }
3951
3952    /**
3953     * Sets the enabled state of the profile. A profile should be enabled only once it is ready to
3954     * be used. Only the profile owner can call this.
3955     *
3956     * @see #isProfileOwnerApp
3957     * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
3958     * @throws SecurityException if {@code admin} is not a profile owner.
3959     */
3960    public void setProfileEnabled(@NonNull ComponentName admin) {
3961        throwIfParentInstance("setProfileEnabled");
3962        if (mService != null) {
3963            try {
3964                mService.setProfileEnabled(admin);
3965            } catch (RemoteException e) {
3966                throw e.rethrowFromSystemServer();
3967            }
3968        }
3969    }
3970
3971    /**
3972     * Sets the name of the profile. In the device owner case it sets the name of the user which it
3973     * is called from. Only a profile owner or device owner can call this. If this is never called
3974     * by the profile or device owner, the name will be set to default values.
3975     *
3976     * @see #isProfileOwnerApp
3977     * @see #isDeviceOwnerApp
3978     * @param admin Which {@link DeviceAdminReceiver} this request is associate with.
3979     * @param profileName The name of the profile.
3980     * @throws SecurityException if {@code admin} is not a device or profile owner.
3981     */
3982    public void setProfileName(@NonNull ComponentName admin, String profileName) {
3983        throwIfParentInstance("setProfileName");
3984        if (mService != null) {
3985            try {
3986                mService.setProfileName(admin, profileName);
3987            } catch (RemoteException e) {
3988                throw e.rethrowFromSystemServer();
3989            }
3990        }
3991    }
3992
3993    /**
3994     * Used to determine if a particular package is registered as the profile owner for the
3995     * user. A profile owner is a special device admin that has additional privileges
3996     * within the profile.
3997     *
3998     * @param packageName The package name of the app to compare with the registered profile owner.
3999     * @return Whether or not the package is registered as the profile owner.
4000     */
4001    public boolean isProfileOwnerApp(String packageName) {
4002        throwIfParentInstance("isProfileOwnerApp");
4003        if (mService != null) {
4004            try {
4005                ComponentName profileOwner = mService.getProfileOwner(myUserId());
4006                return profileOwner != null
4007                        && profileOwner.getPackageName().equals(packageName);
4008            } catch (RemoteException re) {
4009                throw re.rethrowFromSystemServer();
4010            }
4011        }
4012        return false;
4013    }
4014
4015    /**
4016     * @hide
4017     * @return the packageName of the owner of the given user profile or {@code null} if no profile
4018     * owner has been set for that user.
4019     * @throws IllegalArgumentException if the userId is invalid.
4020     */
4021    @SystemApi
4022    public ComponentName getProfileOwner() throws IllegalArgumentException {
4023        throwIfParentInstance("getProfileOwner");
4024        return getProfileOwnerAsUser(Process.myUserHandle().getIdentifier());
4025    }
4026
4027    /**
4028     * @see #getProfileOwner()
4029     * @hide
4030     */
4031    public ComponentName getProfileOwnerAsUser(final int userId) throws IllegalArgumentException {
4032        if (mService != null) {
4033            try {
4034                return mService.getProfileOwner(userId);
4035            } catch (RemoteException re) {
4036                throw re.rethrowFromSystemServer();
4037            }
4038        }
4039        return null;
4040    }
4041
4042    /**
4043     * @hide
4044     * @return the human readable name of the organisation associated with this DPM or {@code null}
4045     *         if one is not set.
4046     * @throws IllegalArgumentException if the userId is invalid.
4047     */
4048    public String getProfileOwnerName() throws IllegalArgumentException {
4049        if (mService != null) {
4050            try {
4051                return mService.getProfileOwnerName(Process.myUserHandle().getIdentifier());
4052            } catch (RemoteException re) {
4053                throw re.rethrowFromSystemServer();
4054            }
4055        }
4056        return null;
4057    }
4058
4059    /**
4060     * @hide
4061     * @param userId The user for whom to fetch the profile owner name, if any.
4062     * @return the human readable name of the organisation associated with this profile owner or
4063     *         null if one is not set.
4064     * @throws IllegalArgumentException if the userId is invalid.
4065     */
4066    @SystemApi
4067    public String getProfileOwnerNameAsUser(int userId) throws IllegalArgumentException {
4068        throwIfParentInstance("getProfileOwnerNameAsUser");
4069        if (mService != null) {
4070            try {
4071                return mService.getProfileOwnerName(userId);
4072            } catch (RemoteException re) {
4073                throw re.rethrowFromSystemServer();
4074            }
4075        }
4076        return null;
4077    }
4078
4079    /**
4080     * Called by a profile owner or device owner to add a default intent handler activity for
4081     * intents that match a certain intent filter. This activity will remain the default intent
4082     * handler even if the set of potential event handlers for the intent filter changes and if the
4083     * intent preferences are reset.
4084     * <p>
4085     * The default disambiguation mechanism takes over if the activity is not installed (anymore).
4086     * When the activity is (re)installed, it is automatically reset as default intent handler for
4087     * the filter.
4088     * <p>
4089     * The calling device admin must be a profile owner or device owner. If it is not, a security
4090     * exception will be thrown.
4091     *
4092     * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
4093     * @param filter The IntentFilter for which a default handler is added.
4094     * @param activity The Activity that is added as default intent handler.
4095     * @throws SecurityException if {@code admin} is not a device or profile owner.
4096     */
4097    public void addPersistentPreferredActivity(@NonNull ComponentName admin, IntentFilter filter,
4098            @NonNull ComponentName activity) {
4099        throwIfParentInstance("addPersistentPreferredActivity");
4100        if (mService != null) {
4101            try {
4102                mService.addPersistentPreferredActivity(admin, filter, activity);
4103            } catch (RemoteException e) {
4104                throw e.rethrowFromSystemServer();
4105            }
4106        }
4107    }
4108
4109    /**
4110     * Called by a profile owner or device owner to remove all persistent intent handler preferences
4111     * associated with the given package that were set by {@link #addPersistentPreferredActivity}.
4112     * <p>
4113     * The calling device admin must be a profile owner. If it is not, a security exception will be
4114     * thrown.
4115     *
4116     * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
4117     * @param packageName The name of the package for which preferences are removed.
4118     * @throws SecurityException if {@code admin} is not a device or profile owner.
4119     */
4120    public void clearPackagePersistentPreferredActivities(@NonNull ComponentName admin,
4121            String packageName) {
4122        throwIfParentInstance("clearPackagePersistentPreferredActivities");
4123        if (mService != null) {
4124            try {
4125                mService.clearPackagePersistentPreferredActivities(admin, packageName);
4126            } catch (RemoteException e) {
4127                throw e.rethrowFromSystemServer();
4128            }
4129        }
4130    }
4131
4132    /**
4133     * Called by a profile owner or device owner to grant permission to a package to manage
4134     * application restrictions for the calling user via {@link #setApplicationRestrictions} and
4135     * {@link #getApplicationRestrictions}.
4136     * <p>
4137     * This permission is persistent until it is later cleared by calling this method with a
4138     * {@code null} value or uninstalling the managing package.
4139     * <p>
4140     * The supplied application restriction managing package must be installed when calling this
4141     * API, otherwise an {@link NameNotFoundException} will be thrown.
4142     *
4143     * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
4144     * @param packageName The package name which will be given access to application restrictions
4145     *            APIs. If {@code null} is given the current package will be cleared.
4146     * @throws SecurityException if {@code admin} is not a device or profile owner.
4147     * @throws NameNotFoundException if {@code packageName} is not found
4148     */
4149    public void setApplicationRestrictionsManagingPackage(@NonNull ComponentName admin,
4150            @Nullable String packageName) throws NameNotFoundException {
4151        throwIfParentInstance("setApplicationRestrictionsManagingPackage");
4152        if (mService != null) {
4153            try {
4154                if (!mService.setApplicationRestrictionsManagingPackage(admin, packageName)) {
4155                    throw new NameNotFoundException(packageName);
4156                }
4157            } catch (RemoteException e) {
4158                throw e.rethrowFromSystemServer();
4159            }
4160        }
4161    }
4162
4163    /**
4164     * Called by a profile owner or device owner to retrieve the application restrictions managing
4165     * package for the current user, or {@code null} if none is set.
4166     *
4167     * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
4168     * @return The package name allowed to manage application restrictions on the current user, or
4169     *         {@code null} if none is set.
4170     * @throws SecurityException if {@code admin} is not a device or profile owner.
4171     */
4172    public String getApplicationRestrictionsManagingPackage(@NonNull ComponentName admin) {
4173        throwIfParentInstance("getApplicationRestrictionsManagingPackage");
4174        if (mService != null) {
4175            try {
4176                return mService.getApplicationRestrictionsManagingPackage(admin);
4177            } catch (RemoteException e) {
4178                throw e.rethrowFromSystemServer();
4179            }
4180        }
4181        return null;
4182    }
4183
4184    /**
4185     * Called by any application to find out whether it has been granted permission via
4186     * {@link #setApplicationRestrictionsManagingPackage} to manage application restrictions
4187     * for the calling user.
4188     *
4189     * <p>This is done by comparing the calling Linux uid with the uid of the package specified by
4190     * that method.
4191     */
4192    public boolean isCallerApplicationRestrictionsManagingPackage() {
4193        throwIfParentInstance("isCallerApplicationRestrictionsManagingPackage");
4194        if (mService != null) {
4195            try {
4196                return mService.isCallerApplicationRestrictionsManagingPackage();
4197            } catch (RemoteException e) {
4198                throw e.rethrowFromSystemServer();
4199            }
4200        }
4201        return false;
4202    }
4203
4204    /**
4205     * Sets the application restrictions for a given target application running in the calling user.
4206     * <p>
4207     * The caller must be a profile or device owner on that user, or the package allowed to manage
4208     * application restrictions via {@link #setApplicationRestrictionsManagingPackage}; otherwise a
4209     * security exception will be thrown.
4210     * <p>
4211     * The provided {@link Bundle} consists of key-value pairs, where the types of values may be:
4212     * <ul>
4213     * <li>{@code boolean}
4214     * <li>{@code int}
4215     * <li>{@code String} or {@code String[]}
4216     * <li>From {@link android.os.Build.VERSION_CODES#M}, {@code Bundle} or {@code Bundle[]}
4217     * </ul>
4218     * <p>
4219     * If the restrictions are not available yet, but may be applied in the near future, the caller
4220     * can notify the target application of that by adding
4221     * {@link UserManager#KEY_RESTRICTIONS_PENDING} to the settings parameter.
4222     * <p>
4223     * The application restrictions are only made visible to the target application via
4224     * {@link UserManager#getApplicationRestrictions(String)}, in addition to the profile or device
4225     * owner, and the application restrictions managing package via
4226     * {@link #getApplicationRestrictions}.
4227     *
4228     * @param admin Which {@link DeviceAdminReceiver} this request is associated with, or
4229     *            {@code null} if called by the application restrictions managing package.
4230     * @param packageName The name of the package to update restricted settings for.
4231     * @param settings A {@link Bundle} to be parsed by the receiving application, conveying a new
4232     *            set of active restrictions.
4233     * @throws SecurityException if {@code admin} is not a device or profile owner.
4234     * @see #setApplicationRestrictionsManagingPackage
4235     * @see UserManager#KEY_RESTRICTIONS_PENDING
4236     */
4237    public void setApplicationRestrictions(@Nullable ComponentName admin, String packageName,
4238            Bundle settings) {
4239        throwIfParentInstance("setApplicationRestrictions");
4240        if (mService != null) {
4241            try {
4242                mService.setApplicationRestrictions(admin, packageName, settings);
4243            } catch (RemoteException e) {
4244                throw e.rethrowFromSystemServer();
4245            }
4246        }
4247    }
4248
4249    /**
4250     * Sets a list of configuration features to enable for a TrustAgent component. This is meant to
4251     * be used in conjunction with {@link #KEYGUARD_DISABLE_TRUST_AGENTS}, which disables all trust
4252     * agents but those enabled by this function call. If flag
4253     * {@link #KEYGUARD_DISABLE_TRUST_AGENTS} is not set, then this call has no effect.
4254     * <p>
4255     * The calling device admin must have requested
4256     * {@link DeviceAdminInfo#USES_POLICY_DISABLE_KEYGUARD_FEATURES} to be able to call this method;
4257     * if not, a security exception will be thrown.
4258     * <p>
4259     * This method can be called on the {@link DevicePolicyManager} instance returned by
4260     * {@link #getParentProfileInstance(ComponentName)} in order to set the configuration for
4261     * the parent profile.
4262     *
4263     * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
4264     * @param target Component name of the agent to be enabled.
4265     * @param configuration TrustAgent-specific feature bundle. If null for any admin, agent will be
4266     *            strictly disabled according to the state of the
4267     *            {@link #KEYGUARD_DISABLE_TRUST_AGENTS} flag.
4268     *            <p>
4269     *            If {@link #KEYGUARD_DISABLE_TRUST_AGENTS} is set and options is not null for all
4270     *            admins, then it's up to the TrustAgent itself to aggregate the values from all
4271     *            device admins.
4272     *            <p>
4273     *            Consult documentation for the specific TrustAgent to determine legal options
4274     *            parameters.
4275     * @throws SecurityException if {@code admin} is not an active administrator or does not use
4276     *             {@link DeviceAdminInfo#USES_POLICY_DISABLE_KEYGUARD_FEATURES}
4277     */
4278    public void setTrustAgentConfiguration(@NonNull ComponentName admin,
4279            @NonNull ComponentName target, PersistableBundle configuration) {
4280        if (mService != null) {
4281            try {
4282                mService.setTrustAgentConfiguration(admin, target, configuration, mParentInstance);
4283            } catch (RemoteException e) {
4284                throw e.rethrowFromSystemServer();
4285            }
4286        }
4287    }
4288
4289    /**
4290     * Gets configuration for the given trust agent based on aggregating all calls to
4291     * {@link #setTrustAgentConfiguration(ComponentName, ComponentName, PersistableBundle)} for
4292     * all device admins.
4293     * <p>
4294     * This method can be called on the {@link DevicePolicyManager} instance returned by
4295     * {@link #getParentProfileInstance(ComponentName)} in order to retrieve the configuration set
4296     * on the parent profile.
4297     *
4298     * @param admin Which {@link DeviceAdminReceiver} this request is associated with. If null,
4299     * this function returns a list of configurations for all admins that declare
4300     * {@link #KEYGUARD_DISABLE_TRUST_AGENTS}. If any admin declares
4301     * {@link #KEYGUARD_DISABLE_TRUST_AGENTS} but doesn't call
4302     * {@link #setTrustAgentConfiguration(ComponentName, ComponentName, PersistableBundle)}
4303     * for this {@param agent} or calls it with a null configuration, null is returned.
4304     * @param agent Which component to get enabled features for.
4305     * @return configuration for the given trust agent.
4306     */
4307    public List<PersistableBundle> getTrustAgentConfiguration(@Nullable ComponentName admin,
4308            @NonNull ComponentName agent) {
4309        return getTrustAgentConfiguration(admin, agent, myUserId());
4310    }
4311
4312    /** @hide per-user version */
4313    public List<PersistableBundle> getTrustAgentConfiguration(@Nullable ComponentName admin,
4314            @NonNull ComponentName agent, int userHandle) {
4315        if (mService != null) {
4316            try {
4317                return mService.getTrustAgentConfiguration(admin, agent, userHandle,
4318                        mParentInstance);
4319            } catch (RemoteException e) {
4320                throw e.rethrowFromSystemServer();
4321            }
4322        }
4323        return new ArrayList<PersistableBundle>(); // empty list
4324    }
4325
4326    /**
4327     * Called by a profile owner of a managed profile to set whether caller-Id information from the
4328     * managed profile will be shown in the parent profile, for incoming calls.
4329     * <p>
4330     * The calling device admin must be a profile owner. If it is not, a security exception will be
4331     * thrown.
4332     *
4333     * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
4334     * @param disabled If true caller-Id information in the managed profile is not displayed.
4335     * @throws SecurityException if {@code admin} is not a device or profile owner.
4336     */
4337    public void setCrossProfileCallerIdDisabled(@NonNull ComponentName admin, boolean disabled) {
4338        throwIfParentInstance("setCrossProfileCallerIdDisabled");
4339        if (mService != null) {
4340            try {
4341                mService.setCrossProfileCallerIdDisabled(admin, disabled);
4342            } catch (RemoteException e) {
4343                throw e.rethrowFromSystemServer();
4344            }
4345        }
4346    }
4347
4348    /**
4349     * Called by a profile owner of a managed profile to determine whether or not caller-Id
4350     * information has been disabled.
4351     * <p>
4352     * The calling device admin must be a profile owner. If it is not, a security exception will be
4353     * thrown.
4354     *
4355     * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
4356     * @throws SecurityException if {@code admin} is not a device or profile owner.
4357     */
4358    public boolean getCrossProfileCallerIdDisabled(@NonNull ComponentName admin) {
4359        throwIfParentInstance("getCrossProfileCallerIdDisabled");
4360        if (mService != null) {
4361            try {
4362                return mService.getCrossProfileCallerIdDisabled(admin);
4363            } catch (RemoteException e) {
4364                throw e.rethrowFromSystemServer();
4365            }
4366        }
4367        return false;
4368    }
4369
4370    /**
4371     * Determine whether or not caller-Id information has been disabled.
4372     *
4373     * @param userHandle The user for whom to check the caller-id permission
4374     * @hide
4375     */
4376    public boolean getCrossProfileCallerIdDisabled(UserHandle userHandle) {
4377        if (mService != null) {
4378            try {
4379                return mService.getCrossProfileCallerIdDisabledForUser(userHandle.getIdentifier());
4380            } catch (RemoteException e) {
4381                throw e.rethrowFromSystemServer();
4382            }
4383        }
4384        return false;
4385    }
4386
4387    /**
4388     * Called by a profile owner of a managed profile to set whether contacts search from the
4389     * managed profile will be shown in the parent profile, for incoming calls.
4390     * <p>
4391     * The calling device admin must be a profile owner. If it is not, a security exception will be
4392     * thrown.
4393     *
4394     * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
4395     * @param disabled If true contacts search in the managed profile is not displayed.
4396     * @throws SecurityException if {@code admin} is not a device or profile owner.
4397     */
4398    public void setCrossProfileContactsSearchDisabled(@NonNull ComponentName admin,
4399            boolean disabled) {
4400        throwIfParentInstance("setCrossProfileContactsSearchDisabled");
4401        if (mService != null) {
4402            try {
4403                mService.setCrossProfileContactsSearchDisabled(admin, disabled);
4404            } catch (RemoteException e) {
4405                throw e.rethrowFromSystemServer();
4406            }
4407        }
4408    }
4409
4410    /**
4411     * Called by a profile owner of a managed profile to determine whether or not contacts search
4412     * has been disabled.
4413     * <p>
4414     * The calling device admin must be a profile owner. If it is not, a security exception will be
4415     * thrown.
4416     *
4417     * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
4418     * @throws SecurityException if {@code admin} is not a device or profile owner.
4419     */
4420    public boolean getCrossProfileContactsSearchDisabled(@NonNull ComponentName admin) {
4421        throwIfParentInstance("getCrossProfileContactsSearchDisabled");
4422        if (mService != null) {
4423            try {
4424                return mService.getCrossProfileContactsSearchDisabled(admin);
4425            } catch (RemoteException e) {
4426                throw e.rethrowFromSystemServer();
4427            }
4428        }
4429        return false;
4430    }
4431
4432
4433    /**
4434     * Determine whether or not contacts search has been disabled.
4435     *
4436     * @param userHandle The user for whom to check the contacts search permission
4437     * @hide
4438     */
4439    public boolean getCrossProfileContactsSearchDisabled(@NonNull UserHandle userHandle) {
4440        if (mService != null) {
4441            try {
4442                return mService
4443                        .getCrossProfileContactsSearchDisabledForUser(userHandle.getIdentifier());
4444            } catch (RemoteException e) {
4445                throw e.rethrowFromSystemServer();
4446            }
4447        }
4448        return false;
4449    }
4450
4451    /**
4452     * Start Quick Contact on the managed profile for the user, if the policy allows.
4453     *
4454     * @hide
4455     */
4456    public void startManagedQuickContact(String actualLookupKey, long actualContactId,
4457            boolean isContactIdIgnored, long directoryId, Intent originalIntent) {
4458        if (mService != null) {
4459            try {
4460                mService.startManagedQuickContact(actualLookupKey, actualContactId,
4461                        isContactIdIgnored, directoryId, originalIntent);
4462            } catch (RemoteException e) {
4463                throw e.rethrowFromSystemServer();
4464            }
4465        }
4466    }
4467
4468    /**
4469     * Start Quick Contact on the managed profile for the user, if the policy allows.
4470     * @hide
4471     */
4472    public void startManagedQuickContact(String actualLookupKey, long actualContactId,
4473            Intent originalIntent) {
4474        startManagedQuickContact(actualLookupKey, actualContactId, false, Directory.DEFAULT,
4475                originalIntent);
4476    }
4477
4478    /**
4479     * Called by a profile owner of a managed profile to set whether bluetooth devices can access
4480     * enterprise contacts.
4481     * <p>
4482     * The calling device admin must be a profile owner. If it is not, a security exception will be
4483     * thrown.
4484     * <p>
4485     * This API works on managed profile only.
4486     *
4487     * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
4488     * @param disabled If true, bluetooth devices cannot access enterprise contacts.
4489     * @throws SecurityException if {@code admin} is not a device or profile owner.
4490     */
4491    public void setBluetoothContactSharingDisabled(@NonNull ComponentName admin, boolean disabled) {
4492        throwIfParentInstance("setBluetoothContactSharingDisabled");
4493        if (mService != null) {
4494            try {
4495                mService.setBluetoothContactSharingDisabled(admin, disabled);
4496            } catch (RemoteException e) {
4497                throw e.rethrowFromSystemServer();
4498            }
4499        }
4500    }
4501
4502    /**
4503     * Called by a profile owner of a managed profile to determine whether or not Bluetooth devices
4504     * cannot access enterprise contacts.
4505     * <p>
4506     * The calling device admin must be a profile owner. If it is not, a security exception will be
4507     * thrown.
4508     * <p>
4509     * This API works on managed profile only.
4510     *
4511     * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
4512     * @throws SecurityException if {@code admin} is not a device or profile owner.
4513     */
4514    public boolean getBluetoothContactSharingDisabled(@NonNull ComponentName admin) {
4515        throwIfParentInstance("getBluetoothContactSharingDisabled");
4516        if (mService != null) {
4517            try {
4518                return mService.getBluetoothContactSharingDisabled(admin);
4519            } catch (RemoteException e) {
4520                throw e.rethrowFromSystemServer();
4521            }
4522        }
4523        return true;
4524    }
4525
4526    /**
4527     * Determine whether or not Bluetooth devices cannot access contacts.
4528     * <p>
4529     * This API works on managed profile UserHandle only.
4530     *
4531     * @param userHandle The user for whom to check the caller-id permission
4532     * @hide
4533     */
4534    public boolean getBluetoothContactSharingDisabled(UserHandle userHandle) {
4535        if (mService != null) {
4536            try {
4537                return mService.getBluetoothContactSharingDisabledForUser(userHandle
4538                        .getIdentifier());
4539            } catch (RemoteException e) {
4540                throw e.rethrowFromSystemServer();
4541            }
4542        }
4543        return true;
4544    }
4545
4546    /**
4547     * Called by the profile owner of a managed profile so that some intents sent in the managed
4548     * profile can also be resolved in the parent, or vice versa. Only activity intents are
4549     * supported.
4550     *
4551     * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
4552     * @param filter The {@link IntentFilter} the intent has to match to be also resolved in the
4553     *            other profile
4554     * @param flags {@link DevicePolicyManager#FLAG_MANAGED_CAN_ACCESS_PARENT} and
4555     *            {@link DevicePolicyManager#FLAG_PARENT_CAN_ACCESS_MANAGED} are supported.
4556     * @throws SecurityException if {@code admin} is not a device or profile owner.
4557     */
4558    public void addCrossProfileIntentFilter(@NonNull ComponentName admin, IntentFilter filter, int flags) {
4559        throwIfParentInstance("addCrossProfileIntentFilter");
4560        if (mService != null) {
4561            try {
4562                mService.addCrossProfileIntentFilter(admin, filter, flags);
4563            } catch (RemoteException e) {
4564                throw e.rethrowFromSystemServer();
4565            }
4566        }
4567    }
4568
4569    /**
4570     * Called by a profile owner of a managed profile to remove the cross-profile intent filters
4571     * that go from the managed profile to the parent, or from the parent to the managed profile.
4572     * Only removes those that have been set by the profile owner.
4573     *
4574     * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
4575     * @throws SecurityException if {@code admin} is not a device or profile owner.
4576     */
4577    public void clearCrossProfileIntentFilters(@NonNull ComponentName admin) {
4578        throwIfParentInstance("clearCrossProfileIntentFilters");
4579        if (mService != null) {
4580            try {
4581                mService.clearCrossProfileIntentFilters(admin);
4582            } catch (RemoteException e) {
4583                throw e.rethrowFromSystemServer();
4584            }
4585        }
4586    }
4587
4588    /**
4589     * Called by a profile or device owner to set the permitted accessibility services. When set by
4590     * a device owner or profile owner the restriction applies to all profiles of the user the
4591     * device owner or profile owner is an admin for. By default the user can use any accessiblity
4592     * service. When zero or more packages have been added, accessiblity services that are not in
4593     * the list and not part of the system can not be enabled by the user.
4594     * <p>
4595     * Calling with a null value for the list disables the restriction so that all services can be
4596     * used, calling with an empty list only allows the builtin system's services.
4597     * <p>
4598     * System accesibility services are always available to the user the list can't modify this.
4599     *
4600     * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
4601     * @param packageNames List of accessibility service package names.
4602     * @return true if setting the restriction succeeded. It fail if there is one or more non-system
4603     *         accessibility services enabled, that are not in the list.
4604     * @throws SecurityException if {@code admin} is not a device or profile owner.
4605     */
4606    public boolean setPermittedAccessibilityServices(@NonNull ComponentName admin,
4607            List<String> packageNames) {
4608        throwIfParentInstance("setPermittedAccessibilityServices");
4609        if (mService != null) {
4610            try {
4611                return mService.setPermittedAccessibilityServices(admin, packageNames);
4612            } catch (RemoteException e) {
4613                throw e.rethrowFromSystemServer();
4614            }
4615        }
4616        return false;
4617    }
4618
4619    /**
4620     * Returns the list of permitted accessibility services set by this device or profile owner.
4621     * <p>
4622     * An empty list means no accessibility services except system services are allowed. Null means
4623     * all accessibility services are allowed.
4624     *
4625     * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
4626     * @return List of accessiblity service package names.
4627     * @throws SecurityException if {@code admin} is not a device or profile owner.
4628     */
4629    public List<String> getPermittedAccessibilityServices(@NonNull ComponentName admin) {
4630        throwIfParentInstance("getPermittedAccessibilityServices");
4631        if (mService != null) {
4632            try {
4633                return mService.getPermittedAccessibilityServices(admin);
4634            } catch (RemoteException e) {
4635                throw e.rethrowFromSystemServer();
4636            }
4637        }
4638        return null;
4639    }
4640
4641    /**
4642     * Called by the system to check if a specific accessibility service is disabled by admin.
4643     *
4644     * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
4645     * @param packageName Accessibility service package name that needs to be checked.
4646     * @param userHandle user id the admin is running as.
4647     * @return true if the accessibility service is permitted, otherwise false.
4648     *
4649     * @hide
4650     */
4651    public boolean isAccessibilityServicePermittedByAdmin(@NonNull ComponentName admin,
4652            @NonNull String packageName, int userHandle) {
4653        if (mService != null) {
4654            try {
4655                return mService.isAccessibilityServicePermittedByAdmin(admin, packageName,
4656                        userHandle);
4657            } catch (RemoteException e) {
4658                throw e.rethrowFromSystemServer();
4659            }
4660        }
4661        return false;
4662    }
4663
4664    /**
4665     * Returns the list of accessibility services permitted by the device or profiles
4666     * owners of this user.
4667     *
4668     * <p>Null means all accessibility services are allowed, if a non-null list is returned
4669     * it will contain the intersection of the permitted lists for any device or profile
4670     * owners that apply to this user. It will also include any system accessibility services.
4671     *
4672     * @param userId which user to check for.
4673     * @return List of accessiblity service package names.
4674     * @hide
4675     */
4676     @SystemApi
4677     public List<String> getPermittedAccessibilityServices(int userId) {
4678        throwIfParentInstance("getPermittedAccessibilityServices");
4679        if (mService != null) {
4680            try {
4681                return mService.getPermittedAccessibilityServicesForUser(userId);
4682            } catch (RemoteException e) {
4683                throw e.rethrowFromSystemServer();
4684            }
4685        }
4686        return null;
4687     }
4688
4689    /**
4690     * Called by a profile or device owner to set the permitted input methods services. When set by
4691     * a device owner or profile owner the restriction applies to all profiles of the user the
4692     * device owner or profile owner is an admin for. By default the user can use any input method.
4693     * When zero or more packages have been added, input method that are not in the list and not
4694     * part of the system can not be enabled by the user. This method will fail if it is called for
4695     * a admin that is not for the foreground user or a profile of the foreground user.
4696     * <p>
4697     * Calling with a null value for the list disables the restriction so that all input methods can
4698     * be used, calling with an empty list disables all but the system's own input methods.
4699     * <p>
4700     * System input methods are always available to the user this method can't modify this.
4701     *
4702     * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
4703     * @param packageNames List of input method package names.
4704     * @return true if setting the restriction succeeded. It will fail if there are one or more
4705     *         non-system input methods currently enabled that are not in the packageNames list.
4706     * @throws SecurityException if {@code admin} is not a device or profile owner.
4707     */
4708    public boolean setPermittedInputMethods(@NonNull ComponentName admin, List<String> packageNames) {
4709        throwIfParentInstance("setPermittedInputMethods");
4710        if (mService != null) {
4711            try {
4712                return mService.setPermittedInputMethods(admin, packageNames);
4713            } catch (RemoteException e) {
4714                throw e.rethrowFromSystemServer();
4715            }
4716        }
4717        return false;
4718    }
4719
4720
4721    /**
4722     * Returns the list of permitted input methods set by this device or profile owner.
4723     * <p>
4724     * An empty list means no input methods except system input methods are allowed. Null means all
4725     * input methods are allowed.
4726     *
4727     * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
4728     * @return List of input method package names.
4729     * @throws SecurityException if {@code admin} is not a device or profile owner.
4730     */
4731    public List<String> getPermittedInputMethods(@NonNull ComponentName admin) {
4732        throwIfParentInstance("getPermittedInputMethods");
4733        if (mService != null) {
4734            try {
4735                return mService.getPermittedInputMethods(admin);
4736            } catch (RemoteException e) {
4737                throw e.rethrowFromSystemServer();
4738            }
4739        }
4740        return null;
4741    }
4742
4743    /**
4744     * Called by the system to check if a specific input method is disabled by admin.
4745     *
4746     * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
4747     * @param packageName Input method package name that needs to be checked.
4748     * @param userHandle user id the admin is running as.
4749     * @return true if the input method is permitted, otherwise false.
4750     *
4751     * @hide
4752     */
4753    public boolean isInputMethodPermittedByAdmin(@NonNull ComponentName admin,
4754            @NonNull String packageName, int userHandle) {
4755        if (mService != null) {
4756            try {
4757                return mService.isInputMethodPermittedByAdmin(admin, packageName, userHandle);
4758            } catch (RemoteException e) {
4759                throw e.rethrowFromSystemServer();
4760            }
4761        }
4762        return false;
4763    }
4764
4765    /**
4766     * Returns the list of input methods permitted by the device or profiles
4767     * owners of the current user.  (*Not* calling user, due to a limitation in InputMethodManager.)
4768     *
4769     * <p>Null means all input methods are allowed, if a non-null list is returned
4770     * it will contain the intersection of the permitted lists for any device or profile
4771     * owners that apply to this user. It will also include any system input methods.
4772     *
4773     * @return List of input method package names.
4774     * @hide
4775     */
4776    @SystemApi
4777    public List<String> getPermittedInputMethodsForCurrentUser() {
4778        throwIfParentInstance("getPermittedInputMethodsForCurrentUser");
4779        if (mService != null) {
4780            try {
4781                return mService.getPermittedInputMethodsForCurrentUser();
4782            } catch (RemoteException e) {
4783                throw e.rethrowFromSystemServer();
4784            }
4785        }
4786        return null;
4787    }
4788
4789    /**
4790     * Called by a device owner to get the list of apps to keep around as APKs even if no user has
4791     * currently installed it.
4792     *
4793     * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
4794     *
4795     * @return List of package names to keep cached.
4796     * @hide
4797     */
4798    public List<String> getKeepUninstalledPackages(@NonNull ComponentName admin) {
4799        throwIfParentInstance("getKeepUninstalledPackages");
4800        if (mService != null) {
4801            try {
4802                return mService.getKeepUninstalledPackages(admin);
4803            } catch (RemoteException e) {
4804                throw e.rethrowFromSystemServer();
4805            }
4806        }
4807        return null;
4808    }
4809
4810    /**
4811     * Called by a device owner to set a list of apps to keep around as APKs even if no user has
4812     * currently installed it.
4813     *
4814     * <p>Please note that setting this policy does not imply that specified apps will be
4815     * automatically pre-cached.</p>
4816     *
4817     * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
4818     * @param packageNames List of package names to keep cached.
4819     * @throws SecurityException if {@code admin} is not a device owner.
4820     * @hide
4821     */
4822    public void setKeepUninstalledPackages(@NonNull ComponentName admin,
4823            @NonNull List<String> packageNames) {
4824        throwIfParentInstance("setKeepUninstalledPackages");
4825        if (mService != null) {
4826            try {
4827                mService.setKeepUninstalledPackages(admin, packageNames);
4828            } catch (RemoteException e) {
4829                throw e.rethrowFromSystemServer();
4830            }
4831        }
4832    }
4833
4834    /**
4835     * Called by a device owner to create a user with the specified name. The UserHandle returned
4836     * by this method should not be persisted as user handles are recycled as users are removed and
4837     * created. If you need to persist an identifier for this user, use
4838     * {@link UserManager#getSerialNumberForUser}.
4839     *
4840     * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
4841     * @param name the user's name
4842     * @see UserHandle
4843     * @return the {@link android.os.UserHandle} object for the created user, or {@code null} if the
4844     *         user could not be created.
4845     *
4846     * @deprecated From {@link android.os.Build.VERSION_CODES#M}
4847     * @removed From {@link android.os.Build.VERSION_CODES#N}
4848     */
4849    @Deprecated
4850    public UserHandle createUser(@NonNull ComponentName admin, String name) {
4851        return null;
4852    }
4853
4854    /**
4855     * Called by a device owner to create a user with the specified name. The UserHandle returned
4856     * by this method should not be persisted as user handles are recycled as users are removed and
4857     * created. If you need to persist an identifier for this user, use
4858     * {@link UserManager#getSerialNumberForUser}.  The new user will be started in the background
4859     * immediately.
4860     *
4861     * <p> profileOwnerComponent is the {@link DeviceAdminReceiver} to be the profile owner as well
4862     * as registered as an active admin on the new user.  The profile owner package will be
4863     * installed on the new user if it already is installed on the device.
4864     *
4865     * <p>If the optionalInitializeData is not null, then the extras will be passed to the
4866     * profileOwnerComponent when onEnable is called.
4867     *
4868     * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
4869     * @param name the user's name
4870     * @param ownerName the human readable name of the organisation associated with this DPM.
4871     * @param profileOwnerComponent The {@link DeviceAdminReceiver} that will be an active admin on
4872     *      the user.
4873     * @param adminExtras Extras that will be passed to onEnable of the admin receiver
4874     *      on the new user.
4875     * @see UserHandle
4876     * @return the {@link android.os.UserHandle} object for the created user, or {@code null} if the
4877     *         user could not be created.
4878     *
4879     * @deprecated From {@link android.os.Build.VERSION_CODES#M}
4880     * @removed From {@link android.os.Build.VERSION_CODES#N}
4881     */
4882    @Deprecated
4883    public UserHandle createAndInitializeUser(@NonNull ComponentName admin, String name,
4884            String ownerName, @NonNull ComponentName profileOwnerComponent, Bundle adminExtras) {
4885        return null;
4886    }
4887
4888    /**
4889      * Flag used by {@link #createAndManageUser} to skip setup wizard after creating a new user.
4890      */
4891    public static final int SKIP_SETUP_WIZARD = 0x0001;
4892
4893    /**
4894     * Flag used by {@link #createAndManageUser} to specify that the user should be created
4895     * ephemeral.
4896     * @hide
4897     */
4898    public static final int MAKE_USER_EPHEMERAL = 0x0002;
4899
4900    /**
4901     * Called by a device owner to create a user with the specified name and a given component of
4902     * the calling package as profile owner. The UserHandle returned by this method should not be
4903     * persisted as user handles are recycled as users are removed and created. If you need to
4904     * persist an identifier for this user, use {@link UserManager#getSerialNumberForUser}. The new
4905     * user will not be started in the background.
4906     * <p>
4907     * admin is the {@link DeviceAdminReceiver} which is the device owner. profileOwner is also a
4908     * DeviceAdminReceiver in the same package as admin, and will become the profile owner and will
4909     * be registered as an active admin on the new user. The profile owner package will be installed
4910     * on the new user.
4911     * <p>
4912     * If the adminExtras are not null, they will be stored on the device until the user is started
4913     * for the first time. Then the extras will be passed to the admin when onEnable is called.
4914     *
4915     * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
4916     * @param name The user's name.
4917     * @param profileOwner Which {@link DeviceAdminReceiver} will be profile owner. Has to be in the
4918     *            same package as admin, otherwise no user is created and an
4919     *            IllegalArgumentException is thrown.
4920     * @param adminExtras Extras that will be passed to onEnable of the admin receiver on the new
4921     *            user.
4922     * @param flags {@link #SKIP_SETUP_WIZARD} is supported.
4923     * @see UserHandle
4924     * @return the {@link android.os.UserHandle} object for the created user, or {@code null} if the
4925     *         user could not be created.
4926     * @throws SecurityException if {@code admin} is not a device owner.
4927     */
4928    public UserHandle createAndManageUser(@NonNull ComponentName admin, @NonNull String name,
4929            @NonNull ComponentName profileOwner, @Nullable PersistableBundle adminExtras,
4930            int flags) {
4931        throwIfParentInstance("createAndManageUser");
4932        try {
4933            return mService.createAndManageUser(admin, name, profileOwner, adminExtras, flags);
4934        } catch (RemoteException re) {
4935            throw re.rethrowFromSystemServer();
4936        }
4937    }
4938
4939    /**
4940     * Called by a device owner to remove a user and all associated data. The primary user can not
4941     * be removed.
4942     *
4943     * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
4944     * @param userHandle the user to remove.
4945     * @return {@code true} if the user was removed, {@code false} otherwise.
4946     * @throws SecurityException if {@code admin} is not a device owner.
4947     */
4948    public boolean removeUser(@NonNull ComponentName admin, UserHandle userHandle) {
4949        throwIfParentInstance("removeUser");
4950        try {
4951            return mService.removeUser(admin, userHandle);
4952        } catch (RemoteException re) {
4953            throw re.rethrowFromSystemServer();
4954        }
4955    }
4956
4957    /**
4958     * Called by a device owner to switch the specified user to the foreground.
4959     *
4960     * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
4961     * @param userHandle the user to switch to; null will switch to primary.
4962     * @return {@code true} if the switch was successful, {@code false} otherwise.
4963     * @throws SecurityException if {@code admin} is not a device owner.
4964     * @see Intent#ACTION_USER_FOREGROUND
4965     */
4966    public boolean switchUser(@NonNull ComponentName admin, @Nullable UserHandle userHandle) {
4967        throwIfParentInstance("switchUser");
4968        try {
4969            return mService.switchUser(admin, userHandle);
4970        } catch (RemoteException re) {
4971            throw re.rethrowFromSystemServer();
4972        }
4973    }
4974
4975    /**
4976     * Retrieves the application restrictions for a given target application running in the calling
4977     * user.
4978     * <p>
4979     * The caller must be a profile or device owner on that user, or the package allowed to manage
4980     * application restrictions via {@link #setApplicationRestrictionsManagingPackage}; otherwise a
4981     * security exception will be thrown.
4982     *
4983     * @param admin Which {@link DeviceAdminReceiver} this request is associated with, or
4984     *            {@code null} if called by the application restrictions managing package.
4985     * @param packageName The name of the package to fetch restricted settings of.
4986     * @return {@link Bundle} of settings corresponding to what was set last time
4987     *         {@link DevicePolicyManager#setApplicationRestrictions} was called, or an empty
4988     *         {@link Bundle} if no restrictions have been set.
4989     * @throws SecurityException if {@code admin} is not a device or profile owner.
4990     * @see {@link #setApplicationRestrictionsManagingPackage}
4991     */
4992    public Bundle getApplicationRestrictions(@Nullable ComponentName admin, String packageName) {
4993        throwIfParentInstance("getApplicationRestrictions");
4994        if (mService != null) {
4995            try {
4996                return mService.getApplicationRestrictions(admin, packageName);
4997            } catch (RemoteException e) {
4998                throw e.rethrowFromSystemServer();
4999            }
5000        }
5001        return null;
5002    }
5003
5004    /**
5005     * Called by a profile or device owner to set a user restriction specified by the key.
5006     * <p>
5007     * The calling device admin must be a profile or device owner; if it is not, a security
5008     * exception will be thrown.
5009     *
5010     * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
5011     * @param key The key of the restriction. See the constants in {@link android.os.UserManager}
5012     *            for the list of keys.
5013     * @throws SecurityException if {@code admin} is not a device or profile owner.
5014     */
5015    public void addUserRestriction(@NonNull ComponentName admin, String key) {
5016        throwIfParentInstance("addUserRestriction");
5017        if (mService != null) {
5018            try {
5019                mService.setUserRestriction(admin, key, true);
5020            } catch (RemoteException e) {
5021                throw e.rethrowFromSystemServer();
5022            }
5023        }
5024    }
5025
5026    /**
5027     * Called by a profile or device owner to clear a user restriction specified by the key.
5028     * <p>
5029     * The calling device admin must be a profile or device owner; if it is not, a security
5030     * exception will be thrown.
5031     *
5032     * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
5033     * @param key The key of the restriction. See the constants in {@link android.os.UserManager}
5034     *            for the list of keys.
5035     * @throws SecurityException if {@code admin} is not a device or profile owner.
5036     */
5037    public void clearUserRestriction(@NonNull ComponentName admin, String key) {
5038        throwIfParentInstance("clearUserRestriction");
5039        if (mService != null) {
5040            try {
5041                mService.setUserRestriction(admin, key, false);
5042            } catch (RemoteException e) {
5043                throw e.rethrowFromSystemServer();
5044            }
5045        }
5046    }
5047
5048    /**
5049     * Called by a profile or device owner to get user restrictions set with
5050     * {@link #addUserRestriction(ComponentName, String)}.
5051     * <p>
5052     * The target user may have more restrictions set by the system or other device owner / profile
5053     * owner. To get all the user restrictions currently set, use
5054     * {@link UserManager#getUserRestrictions()}.
5055     *
5056     * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
5057     * @throws SecurityException if {@code admin} is not a device or profile owner.
5058     */
5059    public Bundle getUserRestrictions(@NonNull ComponentName admin) {
5060        throwIfParentInstance("getUserRestrictions");
5061        Bundle ret = null;
5062        if (mService != null) {
5063            try {
5064                ret = mService.getUserRestrictions(admin);
5065            } catch (RemoteException e) {
5066                throw e.rethrowFromSystemServer();
5067            }
5068        }
5069        return ret == null ? new Bundle() : ret;
5070    }
5071
5072    /**
5073     * Called by profile or device owners to hide or unhide packages. When a package is hidden it is
5074     * unavailable for use, but the data and actual package file remain.
5075     *
5076     * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
5077     * @param packageName The name of the package to hide or unhide.
5078     * @param hidden {@code true} if the package should be hidden, {@code false} if it should be
5079     *            unhidden.
5080     * @return boolean Whether the hidden setting of the package was successfully updated.
5081     * @throws SecurityException if {@code admin} is not a device or profile owner.
5082     */
5083    public boolean setApplicationHidden(@NonNull ComponentName admin, String packageName,
5084            boolean hidden) {
5085        throwIfParentInstance("setApplicationHidden");
5086        if (mService != null) {
5087            try {
5088                return mService.setApplicationHidden(admin, packageName, hidden);
5089            } catch (RemoteException e) {
5090                throw e.rethrowFromSystemServer();
5091            }
5092        }
5093        return false;
5094    }
5095
5096    /**
5097     * Called by profile or device owners to determine if a package is hidden.
5098     *
5099     * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
5100     * @param packageName The name of the package to retrieve the hidden status of.
5101     * @return boolean {@code true} if the package is hidden, {@code false} otherwise.
5102     * @throws SecurityException if {@code admin} is not a device or profile owner.
5103     */
5104    public boolean isApplicationHidden(@NonNull ComponentName admin, String packageName) {
5105        throwIfParentInstance("isApplicationHidden");
5106        if (mService != null) {
5107            try {
5108                return mService.isApplicationHidden(admin, packageName);
5109            } catch (RemoteException e) {
5110                throw e.rethrowFromSystemServer();
5111            }
5112        }
5113        return false;
5114    }
5115
5116    /**
5117     * Called by profile or device owners to re-enable a system app that was disabled by default
5118     * when the user was initialized.
5119     *
5120     * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
5121     * @param packageName The package to be re-enabled in the calling profile.
5122     * @throws SecurityException if {@code admin} is not a device or profile owner.
5123     */
5124    public void enableSystemApp(@NonNull ComponentName admin, String packageName) {
5125        throwIfParentInstance("enableSystemApp");
5126        if (mService != null) {
5127            try {
5128                mService.enableSystemApp(admin, packageName);
5129            } catch (RemoteException e) {
5130                throw e.rethrowFromSystemServer();
5131            }
5132        }
5133    }
5134
5135    /**
5136     * Called by profile or device owners to re-enable system apps by intent that were disabled by
5137     * default when the user was initialized.
5138     *
5139     * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
5140     * @param intent An intent matching the app(s) to be installed. All apps that resolve for this
5141     *            intent will be re-enabled in the calling profile.
5142     * @return int The number of activities that matched the intent and were installed.
5143     * @throws SecurityException if {@code admin} is not a device or profile owner.
5144     */
5145    public int enableSystemApp(@NonNull ComponentName admin, Intent intent) {
5146        throwIfParentInstance("enableSystemApp");
5147        if (mService != null) {
5148            try {
5149                return mService.enableSystemAppWithIntent(admin, intent);
5150            } catch (RemoteException e) {
5151                throw e.rethrowFromSystemServer();
5152            }
5153        }
5154        return 0;
5155    }
5156
5157    /**
5158     * Called by a device owner or profile owner to disable account management for a specific type
5159     * of account.
5160     * <p>
5161     * The calling device admin must be a device owner or profile owner. If it is not, a security
5162     * exception will be thrown.
5163     * <p>
5164     * When account management is disabled for an account type, adding or removing an account of
5165     * that type will not be possible.
5166     * <p>
5167     * From {@link android.os.Build.VERSION_CODES#N} the profile or device owner can still use
5168     * {@link android.accounts.AccountManager} APIs to add or remove accounts when account
5169     * management for a specific type is disabled.
5170     *
5171     * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
5172     * @param accountType For which account management is disabled or enabled.
5173     * @param disabled The boolean indicating that account management will be disabled (true) or
5174     *            enabled (false).
5175     * @throws SecurityException if {@code admin} is not a device or profile owner.
5176     */
5177    public void setAccountManagementDisabled(@NonNull ComponentName admin, String accountType,
5178            boolean disabled) {
5179        throwIfParentInstance("setAccountManagementDisabled");
5180        if (mService != null) {
5181            try {
5182                mService.setAccountManagementDisabled(admin, accountType, disabled);
5183            } catch (RemoteException e) {
5184                throw e.rethrowFromSystemServer();
5185            }
5186        }
5187    }
5188
5189    /**
5190     * Gets the array of accounts for which account management is disabled by the profile owner.
5191     *
5192     * <p> Account management can be disabled/enabled by calling
5193     * {@link #setAccountManagementDisabled}.
5194     *
5195     * @return a list of account types for which account management has been disabled.
5196     *
5197     * @see #setAccountManagementDisabled
5198     */
5199    public String[] getAccountTypesWithManagementDisabled() {
5200        throwIfParentInstance("getAccountTypesWithManagementDisabled");
5201        return getAccountTypesWithManagementDisabledAsUser(myUserId());
5202    }
5203
5204    /**
5205     * @see #getAccountTypesWithManagementDisabled()
5206     * @hide
5207     */
5208    public String[] getAccountTypesWithManagementDisabledAsUser(int userId) {
5209        if (mService != null) {
5210            try {
5211                return mService.getAccountTypesWithManagementDisabledAsUser(userId);
5212            } catch (RemoteException e) {
5213                throw e.rethrowFromSystemServer();
5214            }
5215        }
5216
5217        return null;
5218    }
5219
5220    /**
5221     * Sets which packages may enter lock task mode.
5222     * <p>
5223     * Any packages that shares uid with an allowed package will also be allowed to activate lock
5224     * task. From {@link android.os.Build.VERSION_CODES#M} removing packages from the lock task
5225     * package list results in locked tasks belonging to those packages to be finished. This
5226     * function can only be called by the device owner.
5227     *
5228     * @param packages The list of packages allowed to enter lock task mode
5229     * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
5230     * @throws SecurityException if {@code admin} is not a device owner.
5231     * @see Activity#startLockTask()
5232     * @see DeviceAdminReceiver#onLockTaskModeEntering(Context, Intent, String)
5233     * @see DeviceAdminReceiver#onLockTaskModeExiting(Context, Intent)
5234     * @see UserManager#DISALLOW_CREATE_WINDOWS
5235     */
5236    public void setLockTaskPackages(@NonNull ComponentName admin, String[] packages)
5237            throws SecurityException {
5238        throwIfParentInstance("setLockTaskPackages");
5239        if (mService != null) {
5240            try {
5241                mService.setLockTaskPackages(admin, packages);
5242            } catch (RemoteException e) {
5243                throw e.rethrowFromSystemServer();
5244            }
5245        }
5246    }
5247
5248    /**
5249     * This function returns the list of packages allowed to start the lock task mode.
5250     *
5251     * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
5252     * @hide
5253     */
5254    public String[] getLockTaskPackages(@NonNull ComponentName admin) {
5255        throwIfParentInstance("getLockTaskPackages");
5256        if (mService != null) {
5257            try {
5258                return mService.getLockTaskPackages(admin);
5259            } catch (RemoteException e) {
5260                throw e.rethrowFromSystemServer();
5261            }
5262        }
5263        return null;
5264    }
5265
5266    /**
5267     * This function lets the caller know whether the given component is allowed to start the
5268     * lock task mode.
5269     * @param pkg The package to check
5270     */
5271    public boolean isLockTaskPermitted(String pkg) {
5272        throwIfParentInstance("isLockTaskPermitted");
5273        if (mService != null) {
5274            try {
5275                return mService.isLockTaskPermitted(pkg);
5276            } catch (RemoteException e) {
5277                throw e.rethrowFromSystemServer();
5278            }
5279        }
5280        return false;
5281    }
5282
5283    /**
5284     * Called by device owners to update {@link Settings.Global} settings. Validation that the value
5285     * of the setting is in the correct form for the setting type should be performed by the caller.
5286     * <p>
5287     * The settings that can be updated with this method are:
5288     * <ul>
5289     * <li>{@link Settings.Global#ADB_ENABLED}</li>
5290     * <li>{@link Settings.Global#AUTO_TIME}</li>
5291     * <li>{@link Settings.Global#AUTO_TIME_ZONE}</li>
5292     * <li>{@link Settings.Global#DATA_ROAMING}</li>
5293     * <li>{@link Settings.Global#USB_MASS_STORAGE_ENABLED}</li>
5294     * <li>{@link Settings.Global#WIFI_SLEEP_POLICY}</li>
5295     * <li>{@link Settings.Global#STAY_ON_WHILE_PLUGGED_IN} This setting is only available from
5296     * {@link android.os.Build.VERSION_CODES#M} onwards and can only be set if
5297     * {@link #setMaximumTimeToLock} is not used to set a timeout.</li>
5298     * <li>{@link Settings.Global#WIFI_DEVICE_OWNER_CONFIGS_LOCKDOWN}</li> This setting is only
5299     * available from {@link android.os.Build.VERSION_CODES#M} onwards.</li>
5300     * </ul>
5301     * <p>
5302     * Changing the following settings has no effect as of {@link android.os.Build.VERSION_CODES#M}:
5303     * <ul>
5304     * <li>{@link Settings.Global#BLUETOOTH_ON}. Use
5305     * {@link android.bluetooth.BluetoothAdapter#enable()} and
5306     * {@link android.bluetooth.BluetoothAdapter#disable()} instead.</li>
5307     * <li>{@link Settings.Global#DEVELOPMENT_SETTINGS_ENABLED}</li>
5308     * <li>{@link Settings.Global#MODE_RINGER}. Use
5309     * {@link android.media.AudioManager#setRingerMode(int)} instead.</li>
5310     * <li>{@link Settings.Global#NETWORK_PREFERENCE}</li>
5311     * <li>{@link Settings.Global#WIFI_ON}. Use
5312     * {@link android.net.wifi.WifiManager#setWifiEnabled(boolean)} instead.</li>
5313     * </ul>
5314     *
5315     * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
5316     * @param setting The name of the setting to update.
5317     * @param value The value to update the setting to.
5318     * @throws SecurityException if {@code admin} is not a device owner.
5319     */
5320    public void setGlobalSetting(@NonNull ComponentName admin, String setting, String value) {
5321        throwIfParentInstance("setGlobalSetting");
5322        if (mService != null) {
5323            try {
5324                mService.setGlobalSetting(admin, setting, value);
5325            } catch (RemoteException e) {
5326                throw e.rethrowFromSystemServer();
5327            }
5328        }
5329    }
5330
5331    /**
5332     * Called by profile or device owners to update {@link Settings.Secure} settings. Validation
5333     * that the value of the setting is in the correct form for the setting type should be performed
5334     * by the caller.
5335     * <p>
5336     * The settings that can be updated by a profile or device owner with this method are:
5337     * <ul>
5338     * <li>{@link Settings.Secure#DEFAULT_INPUT_METHOD}</li>
5339     * <li>{@link Settings.Secure#INSTALL_NON_MARKET_APPS}</li>
5340     * <li>{@link Settings.Secure#SKIP_FIRST_USE_HINTS}</li>
5341     * </ul>
5342     * <p>
5343     * A device owner can additionally update the following settings:
5344     * <ul>
5345     * <li>{@link Settings.Secure#LOCATION_MODE}</li>
5346     * </ul>
5347     *
5348     * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
5349     * @param setting The name of the setting to update.
5350     * @param value The value to update the setting to.
5351     * @throws SecurityException if {@code admin} is not a device or profile owner.
5352     */
5353    public void setSecureSetting(@NonNull ComponentName admin, String setting, String value) {
5354        throwIfParentInstance("setSecureSetting");
5355        if (mService != null) {
5356            try {
5357                mService.setSecureSetting(admin, setting, value);
5358            } catch (RemoteException e) {
5359                throw e.rethrowFromSystemServer();
5360            }
5361        }
5362    }
5363
5364    /**
5365     * Designates a specific service component as the provider for making permission requests of a
5366     * local or remote administrator of the user.
5367     * <p/>
5368     * Only a profile owner can designate the restrictions provider.
5369     *
5370     * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
5371     * @param provider The component name of the service that implements
5372     *            {@link RestrictionsReceiver}. If this param is null, it removes the restrictions
5373     *            provider previously assigned.
5374     * @throws SecurityException if {@code admin} is not a device or profile owner.
5375     */
5376    public void setRestrictionsProvider(@NonNull ComponentName admin,
5377            @Nullable ComponentName provider) {
5378        throwIfParentInstance("setRestrictionsProvider");
5379        if (mService != null) {
5380            try {
5381                mService.setRestrictionsProvider(admin, provider);
5382            } catch (RemoteException re) {
5383                throw re.rethrowFromSystemServer();
5384            }
5385        }
5386    }
5387
5388    /**
5389     * Called by profile or device owners to set the master volume mute on or off.
5390     *
5391     * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
5392     * @param on {@code true} to mute master volume, {@code false} to turn mute off.
5393     * @throws SecurityException if {@code admin} is not a device or profile owner.
5394     */
5395    public void setMasterVolumeMuted(@NonNull ComponentName admin, boolean on) {
5396        throwIfParentInstance("setMasterVolumeMuted");
5397        if (mService != null) {
5398            try {
5399                mService.setMasterVolumeMuted(admin, on);
5400            } catch (RemoteException re) {
5401                throw re.rethrowFromSystemServer();
5402            }
5403        }
5404    }
5405
5406    /**
5407     * Called by profile or device owners to check whether the master volume mute is on or off.
5408     *
5409     * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
5410     * @return {@code true} if master volume is muted, {@code false} if it's not.
5411     * @throws SecurityException if {@code admin} is not a device or profile owner.
5412     */
5413    public boolean isMasterVolumeMuted(@NonNull ComponentName admin) {
5414        throwIfParentInstance("isMasterVolumeMuted");
5415        if (mService != null) {
5416            try {
5417                return mService.isMasterVolumeMuted(admin);
5418            } catch (RemoteException re) {
5419                throw re.rethrowFromSystemServer();
5420            }
5421        }
5422        return false;
5423    }
5424
5425    /**
5426     * Called by profile or device owners to change whether a user can uninstall a package.
5427     *
5428     * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
5429     * @param packageName package to change.
5430     * @param uninstallBlocked true if the user shouldn't be able to uninstall the package.
5431     * @throws SecurityException if {@code admin} is not a device or profile owner.
5432     */
5433    public void setUninstallBlocked(@NonNull ComponentName admin, String packageName,
5434            boolean uninstallBlocked) {
5435        throwIfParentInstance("setUninstallBlocked");
5436        if (mService != null) {
5437            try {
5438                mService.setUninstallBlocked(admin, packageName, uninstallBlocked);
5439            } catch (RemoteException re) {
5440                throw re.rethrowFromSystemServer();
5441            }
5442        }
5443    }
5444
5445    /**
5446     * Check whether the user has been blocked by device policy from uninstalling a package.
5447     * Requires the caller to be the profile owner if checking a specific admin's policy.
5448     * <p>
5449     * <strong>Note:</strong> Starting from {@link android.os.Build.VERSION_CODES#LOLLIPOP_MR1}, the
5450     * behavior of this API is changed such that passing {@code null} as the {@code admin} parameter
5451     * will return if any admin has blocked the uninstallation. Before L MR1, passing {@code null}
5452     * will cause a NullPointerException to be raised.
5453     *
5454     * @param admin The name of the admin component whose blocking policy will be checked, or
5455     *            {@code null} to check whether any admin has blocked the uninstallation.
5456     * @param packageName package to check.
5457     * @return true if uninstallation is blocked.
5458     * @throws SecurityException if {@code admin} is not a device or profile owner.
5459     */
5460    public boolean isUninstallBlocked(@Nullable ComponentName admin, String packageName) {
5461        throwIfParentInstance("isUninstallBlocked");
5462        if (mService != null) {
5463            try {
5464                return mService.isUninstallBlocked(admin, packageName);
5465            } catch (RemoteException re) {
5466                throw re.rethrowFromSystemServer();
5467            }
5468        }
5469        return false;
5470    }
5471
5472    /**
5473     * Called by the profile owner of a managed profile to enable widget providers from a given
5474     * package to be available in the parent profile. As a result the user will be able to add
5475     * widgets from the white-listed package running under the profile to a widget host which runs
5476     * under the parent profile, for example the home screen. Note that a package may have zero or
5477     * more provider components, where each component provides a different widget type.
5478     * <p>
5479     * <strong>Note:</strong> By default no widget provider package is white-listed.
5480     *
5481     * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
5482     * @param packageName The package from which widget providers are white-listed.
5483     * @return Whether the package was added.
5484     * @throws SecurityException if {@code admin} is not a profile owner.
5485     * @see #removeCrossProfileWidgetProvider(android.content.ComponentName, String)
5486     * @see #getCrossProfileWidgetProviders(android.content.ComponentName)
5487     */
5488    public boolean addCrossProfileWidgetProvider(@NonNull ComponentName admin, String packageName) {
5489        throwIfParentInstance("addCrossProfileWidgetProvider");
5490        if (mService != null) {
5491            try {
5492                return mService.addCrossProfileWidgetProvider(admin, packageName);
5493            } catch (RemoteException re) {
5494                throw re.rethrowFromSystemServer();
5495            }
5496        }
5497        return false;
5498    }
5499
5500    /**
5501     * Called by the profile owner of a managed profile to disable widget providers from a given
5502     * package to be available in the parent profile. For this method to take effect the package
5503     * should have been added via
5504     * {@link #addCrossProfileWidgetProvider( android.content.ComponentName, String)}.
5505     * <p>
5506     * <strong>Note:</strong> By default no widget provider package is white-listed.
5507     *
5508     * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
5509     * @param packageName The package from which widget providers are no longer white-listed.
5510     * @return Whether the package was removed.
5511     * @throws SecurityException if {@code admin} is not a profile owner.
5512     * @see #addCrossProfileWidgetProvider(android.content.ComponentName, String)
5513     * @see #getCrossProfileWidgetProviders(android.content.ComponentName)
5514     */
5515    public boolean removeCrossProfileWidgetProvider(
5516            @NonNull ComponentName admin, String packageName) {
5517        throwIfParentInstance("removeCrossProfileWidgetProvider");
5518        if (mService != null) {
5519            try {
5520                return mService.removeCrossProfileWidgetProvider(admin, packageName);
5521            } catch (RemoteException re) {
5522                throw re.rethrowFromSystemServer();
5523            }
5524        }
5525        return false;
5526    }
5527
5528    /**
5529     * Called by the profile owner of a managed profile to query providers from which packages are
5530     * available in the parent profile.
5531     *
5532     * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
5533     * @return The white-listed package list.
5534     * @see #addCrossProfileWidgetProvider(android.content.ComponentName, String)
5535     * @see #removeCrossProfileWidgetProvider(android.content.ComponentName, String)
5536     * @throws SecurityException if {@code admin} is not a profile owner.
5537     */
5538    public List<String> getCrossProfileWidgetProviders(@NonNull ComponentName admin) {
5539        throwIfParentInstance("getCrossProfileWidgetProviders");
5540        if (mService != null) {
5541            try {
5542                List<String> providers = mService.getCrossProfileWidgetProviders(admin);
5543                if (providers != null) {
5544                    return providers;
5545                }
5546            } catch (RemoteException re) {
5547                throw re.rethrowFromSystemServer();
5548            }
5549        }
5550        return Collections.emptyList();
5551    }
5552
5553    /**
5554     * Called by profile or device owners to set the user's photo.
5555     *
5556     * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
5557     * @param icon the bitmap to set as the photo.
5558     * @throws SecurityException if {@code admin} is not a device or profile owner.
5559     */
5560    public void setUserIcon(@NonNull ComponentName admin, Bitmap icon) {
5561        throwIfParentInstance("setUserIcon");
5562        try {
5563            mService.setUserIcon(admin, icon);
5564        } catch (RemoteException re) {
5565            throw re.rethrowFromSystemServer();
5566        }
5567    }
5568
5569    /**
5570     * Called by device owners to set a local system update policy. When a new policy is set,
5571     * {@link #ACTION_SYSTEM_UPDATE_POLICY_CHANGED} is broadcasted.
5572     *
5573     * @param admin Which {@link DeviceAdminReceiver} this request is associated with. All
5574     *            components in the device owner package can set system update policies and the most
5575     *            recent policy takes effect.
5576     * @param policy the new policy, or {@code null} to clear the current policy.
5577     * @throws SecurityException if {@code admin} is not a device owner.
5578     * @see SystemUpdatePolicy
5579     */
5580    public void setSystemUpdatePolicy(@NonNull ComponentName admin, SystemUpdatePolicy policy) {
5581        throwIfParentInstance("setSystemUpdatePolicy");
5582        if (mService != null) {
5583            try {
5584                mService.setSystemUpdatePolicy(admin, policy);
5585            } catch (RemoteException re) {
5586                throw re.rethrowFromSystemServer();
5587            }
5588        }
5589    }
5590
5591    /**
5592     * Retrieve a local system update policy set previously by {@link #setSystemUpdatePolicy}.
5593     *
5594     * @return The current policy object, or {@code null} if no policy is set.
5595     */
5596    public SystemUpdatePolicy getSystemUpdatePolicy() {
5597        throwIfParentInstance("getSystemUpdatePolicy");
5598        if (mService != null) {
5599            try {
5600                return mService.getSystemUpdatePolicy();
5601            } catch (RemoteException re) {
5602                throw re.rethrowFromSystemServer();
5603            }
5604        }
5605        return null;
5606    }
5607
5608    /**
5609     * Called by a device owner to disable the keyguard altogether.
5610     * <p>
5611     * Setting the keyguard to disabled has the same effect as choosing "None" as the screen lock
5612     * type. However, this call has no effect if a password, pin or pattern is currently set. If a
5613     * password, pin or pattern is set after the keyguard was disabled, the keyguard stops being
5614     * disabled.
5615     *
5616     * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
5617     * @param disabled {@code true} disables the keyguard, {@code false} reenables it.
5618     * @return {@code false} if attempting to disable the keyguard while a lock password was in
5619     *         place. {@code true} otherwise.
5620     * @throws SecurityException if {@code admin} is not a device owner.
5621     */
5622    public boolean setKeyguardDisabled(@NonNull ComponentName admin, boolean disabled) {
5623        throwIfParentInstance("setKeyguardDisabled");
5624        try {
5625            return mService.setKeyguardDisabled(admin, disabled);
5626        } catch (RemoteException re) {
5627            throw re.rethrowFromSystemServer();
5628        }
5629    }
5630
5631    /**
5632     * Called by device owner to disable the status bar. Disabling the status bar blocks
5633     * notifications, quick settings and other screen overlays that allow escaping from a single use
5634     * device.
5635     *
5636     * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
5637     * @param disabled {@code true} disables the status bar, {@code false} reenables it.
5638     * @return {@code false} if attempting to disable the status bar failed. {@code true} otherwise.
5639     * @throws SecurityException if {@code admin} is not a device owner.
5640     */
5641    public boolean setStatusBarDisabled(@NonNull ComponentName admin, boolean disabled) {
5642        throwIfParentInstance("setStatusBarDisabled");
5643        try {
5644            return mService.setStatusBarDisabled(admin, disabled);
5645        } catch (RemoteException re) {
5646            throw re.rethrowFromSystemServer();
5647        }
5648    }
5649
5650    /**
5651     * Callable by the system update service to notify device owners about pending updates.
5652     * The caller must hold {@link android.Manifest.permission#NOTIFY_PENDING_SYSTEM_UPDATE}
5653     * permission.
5654     *
5655     * @param updateReceivedTime The time as given by {@link System#currentTimeMillis()} indicating
5656     *        when the current pending update was first available. -1 if no update is available.
5657     * @hide
5658     */
5659    @SystemApi
5660    public void notifyPendingSystemUpdate(long updateReceivedTime) {
5661        throwIfParentInstance("notifyPendingSystemUpdate");
5662        if (mService != null) {
5663            try {
5664                mService.notifyPendingSystemUpdate(updateReceivedTime);
5665            } catch (RemoteException re) {
5666                throw re.rethrowFromSystemServer();
5667            }
5668        }
5669    }
5670
5671    /**
5672     * Called by profile or device owners to set the default response for future runtime permission
5673     * requests by applications. The policy can allow for normal operation which prompts the user to
5674     * grant a permission, or can allow automatic granting or denying of runtime permission requests
5675     * by an application. This also applies to new permissions declared by app updates. When a
5676     * permission is denied or granted this way, the effect is equivalent to setting the permission
5677     * grant state via {@link #setPermissionGrantState}.
5678     * <p/>
5679     * As this policy only acts on runtime permission requests, it only applies to applications
5680     * built with a {@code targetSdkVersion} of {@link android.os.Build.VERSION_CODES#M} or later.
5681     *
5682     * @param admin Which profile or device owner this request is associated with.
5683     * @param policy One of the policy constants {@link #PERMISSION_POLICY_PROMPT},
5684     *            {@link #PERMISSION_POLICY_AUTO_GRANT} and {@link #PERMISSION_POLICY_AUTO_DENY}.
5685     * @throws SecurityException if {@code admin} is not a device or profile owner.
5686     * @see #setPermissionGrantState
5687     */
5688    public void setPermissionPolicy(@NonNull ComponentName admin, int policy) {
5689        throwIfParentInstance("setPermissionPolicy");
5690        try {
5691            mService.setPermissionPolicy(admin, policy);
5692        } catch (RemoteException re) {
5693            throw re.rethrowFromSystemServer();
5694        }
5695    }
5696
5697    /**
5698     * Returns the current runtime permission policy set by the device or profile owner. The
5699     * default is {@link #PERMISSION_POLICY_PROMPT}.
5700     * @param admin Which profile or device owner this request is associated with.
5701     * @return the current policy for future permission requests.
5702     */
5703    public int getPermissionPolicy(ComponentName admin) {
5704        throwIfParentInstance("getPermissionPolicy");
5705        try {
5706            return mService.getPermissionPolicy(admin);
5707        } catch (RemoteException re) {
5708            throw re.rethrowFromSystemServer();
5709        }
5710    }
5711
5712    /**
5713     * Sets the grant state of a runtime permission for a specific application. The state can be
5714     * {@link #PERMISSION_GRANT_STATE_DEFAULT default} in which a user can manage it through the UI,
5715     * {@link #PERMISSION_GRANT_STATE_DENIED denied}, in which the permission is denied and the user
5716     * cannot manage it through the UI, and {@link #PERMISSION_GRANT_STATE_GRANTED granted} in which
5717     * the permission is granted and the user cannot manage it through the UI. This might affect all
5718     * permissions in a group that the runtime permission belongs to. This method can only be called
5719     * by a profile or device owner.
5720     * <p/>
5721     * Setting the grant state to {@link #PERMISSION_GRANT_STATE_DEFAULT default} does not revoke
5722     * the permission. It retains the previous grant, if any.
5723     * <p/>
5724     * Permissions can be granted or revoked only for applications built with a
5725     * {@code targetSdkVersion} of {@link android.os.Build.VERSION_CODES#M} or later.
5726     *
5727     * @param admin Which profile or device owner this request is associated with.
5728     * @param packageName The application to grant or revoke a permission to.
5729     * @param permission The permission to grant or revoke.
5730     * @param grantState The permission grant state which is one of
5731     *            {@link #PERMISSION_GRANT_STATE_DENIED}, {@link #PERMISSION_GRANT_STATE_DEFAULT},
5732     *            {@link #PERMISSION_GRANT_STATE_GRANTED},
5733     * @return whether the permission was successfully granted or revoked.
5734     * @throws SecurityException if {@code admin} is not a device or profile owner.
5735     * @see #PERMISSION_GRANT_STATE_DENIED
5736     * @see #PERMISSION_GRANT_STATE_DEFAULT
5737     * @see #PERMISSION_GRANT_STATE_GRANTED
5738     */
5739    public boolean setPermissionGrantState(@NonNull ComponentName admin, String packageName,
5740            String permission, int grantState) {
5741        throwIfParentInstance("setPermissionGrantState");
5742        try {
5743            return mService.setPermissionGrantState(admin, packageName, permission, grantState);
5744        } catch (RemoteException re) {
5745            throw re.rethrowFromSystemServer();
5746        }
5747    }
5748
5749    /**
5750     * Returns the current grant state of a runtime permission for a specific application.
5751     *
5752     * @param admin Which profile or device owner this request is associated with.
5753     * @param packageName The application to check the grant state for.
5754     * @param permission The permission to check for.
5755     * @return the current grant state specified by device policy. If the profile or device owner
5756     *         has not set a grant state, the return value is
5757     *         {@link #PERMISSION_GRANT_STATE_DEFAULT}. This does not indicate whether or not the
5758     *         permission is currently granted for the package.
5759     *         <p/>
5760     *         If a grant state was set by the profile or device owner, then the return value will
5761     *         be one of {@link #PERMISSION_GRANT_STATE_DENIED} or
5762     *         {@link #PERMISSION_GRANT_STATE_GRANTED}, which indicates if the permission is
5763     *         currently denied or granted.
5764     * @throws SecurityException if {@code admin} is not a device or profile owner.
5765     * @see #setPermissionGrantState(ComponentName, String, String, int)
5766     * @see PackageManager#checkPermission(String, String)
5767     */
5768    public int getPermissionGrantState(@NonNull ComponentName admin, String packageName,
5769            String permission) {
5770        throwIfParentInstance("getPermissionGrantState");
5771        try {
5772            return mService.getPermissionGrantState(admin, packageName, permission);
5773        } catch (RemoteException re) {
5774            throw re.rethrowFromSystemServer();
5775        }
5776    }
5777
5778    /**
5779     * Returns if provisioning a managed profile or device is possible or not.
5780     * @param action One of {@link #ACTION_PROVISION_MANAGED_DEVICE},
5781     * {@link #ACTION_PROVISION_MANAGED_PROFILE}.
5782     * @return if provisioning a managed profile or device is possible or not.
5783     * @throws IllegalArgumentException if the supplied action is not valid.
5784     */
5785    public boolean isProvisioningAllowed(String action) {
5786        throwIfParentInstance("isProvisioningAllowed");
5787        try {
5788            return mService.isProvisioningAllowed(action);
5789        } catch (RemoteException re) {
5790            throw re.rethrowFromSystemServer();
5791        }
5792    }
5793
5794    /**
5795     * Return if this user is a managed profile of another user. An admin can become the profile
5796     * owner of a managed profile with {@link #ACTION_PROVISION_MANAGED_PROFILE} and of a managed
5797     * user with {@link #createAndManageUser}
5798     * @param admin Which profile owner this request is associated with.
5799     * @return if this user is a managed profile of another user.
5800     */
5801    public boolean isManagedProfile(@NonNull ComponentName admin) {
5802        throwIfParentInstance("isManagedProfile");
5803        try {
5804            return mService.isManagedProfile(admin);
5805        } catch (RemoteException re) {
5806            throw re.rethrowFromSystemServer();
5807        }
5808    }
5809
5810    /**
5811     * @hide
5812     * Return if this user is a system-only user. An admin can manage a device from a system only
5813     * user by calling {@link #ACTION_PROVISION_MANAGED_SHAREABLE_DEVICE}.
5814     * @param admin Which device owner this request is associated with.
5815     * @return if this user is a system-only user.
5816     */
5817    public boolean isSystemOnlyUser(@NonNull ComponentName admin) {
5818        try {
5819            return mService.isSystemOnlyUser(admin);
5820        } catch (RemoteException re) {
5821            throw re.rethrowFromSystemServer();
5822        }
5823    }
5824
5825    /**
5826     * Called by device owner to get the MAC address of the Wi-Fi device.
5827     *
5828     * @param admin Which device owner this request is associated with.
5829     * @return the MAC address of the Wi-Fi device, or null when the information is not available.
5830     *         (For example, Wi-Fi hasn't been enabled, or the device doesn't support Wi-Fi.)
5831     *         <p>
5832     *         The address will be in the {@code XX:XX:XX:XX:XX:XX} format.
5833     * @throws SecurityException if {@code admin} is not a device owner.
5834     */
5835    public String getWifiMacAddress(@NonNull ComponentName admin) {
5836        throwIfParentInstance("getWifiMacAddress");
5837        try {
5838            return mService.getWifiMacAddress(admin);
5839        } catch (RemoteException re) {
5840            throw re.rethrowFromSystemServer();
5841        }
5842    }
5843
5844    /**
5845     * Called by device owner to reboot the device. If there is an ongoing call on the device,
5846     * throws an {@link IllegalStateException}.
5847     * @param admin Which device owner the request is associated with.
5848     * @throws IllegalStateException if device has an ongoing call.
5849     * @throws SecurityException if {@code admin} is not a device owner.
5850     * @see TelephonyManager#CALL_STATE_IDLE
5851     */
5852    public void reboot(@NonNull ComponentName admin) {
5853        throwIfParentInstance("reboot");
5854        try {
5855            mService.reboot(admin);
5856        } catch (RemoteException re) {
5857            throw re.rethrowFromSystemServer();
5858        }
5859    }
5860
5861    /**
5862     * Called by a device admin to set the short support message. This will be displayed to the user
5863     * in settings screens where funtionality has been disabled by the admin. The message should be
5864     * limited to a short statement such as "This setting is disabled by your administrator. Contact
5865     * someone@example.com for support." If the message is longer than 200 characters it may be
5866     * truncated.
5867     * <p>
5868     * If the short support message needs to be localized, it is the responsibility of the
5869     * {@link DeviceAdminReceiver} to listen to the {@link Intent#ACTION_LOCALE_CHANGED} broadcast
5870     * and set a new version of this string accordingly.
5871     *
5872     * @see #setLongSupportMessage
5873     * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
5874     * @param message Short message to be displayed to the user in settings or null to clear the
5875     *            existing message.
5876     * @throws SecurityException if {@code admin} is not an active administrator.
5877     */
5878    public void setShortSupportMessage(@NonNull ComponentName admin,
5879            @Nullable CharSequence message) {
5880        throwIfParentInstance("setShortSupportMessage");
5881        if (mService != null) {
5882            try {
5883                mService.setShortSupportMessage(admin, message);
5884            } catch (RemoteException e) {
5885                throw e.rethrowFromSystemServer();
5886            }
5887        }
5888    }
5889
5890    /**
5891     * Called by a device admin to get the short support message.
5892     *
5893     * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
5894     * @return The message set by {@link #setShortSupportMessage(ComponentName, CharSequence)} or
5895     *         null if no message has been set.
5896     * @throws SecurityException if {@code admin} is not an active administrator.
5897     */
5898    public CharSequence getShortSupportMessage(@NonNull ComponentName admin) {
5899        throwIfParentInstance("getShortSupportMessage");
5900        if (mService != null) {
5901            try {
5902                return mService.getShortSupportMessage(admin);
5903            } catch (RemoteException e) {
5904                throw e.rethrowFromSystemServer();
5905            }
5906        }
5907        return null;
5908    }
5909
5910    /**
5911     * Called by a device admin to set the long support message. This will be displayed to the user
5912     * in the device administators settings screen.
5913     * <p>
5914     * If the long support message needs to be localized, it is the responsibility of the
5915     * {@link DeviceAdminReceiver} to listen to the {@link Intent#ACTION_LOCALE_CHANGED} broadcast
5916     * and set a new version of this string accordingly.
5917     *
5918     * @see #setShortSupportMessage
5919     * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
5920     * @param message Long message to be displayed to the user in settings or null to clear the
5921     *            existing message.
5922     * @throws SecurityException if {@code admin} is not an active administrator.
5923     */
5924    public void setLongSupportMessage(@NonNull ComponentName admin,
5925            @Nullable CharSequence message) {
5926        throwIfParentInstance("setLongSupportMessage");
5927        if (mService != null) {
5928            try {
5929                mService.setLongSupportMessage(admin, message);
5930            } catch (RemoteException e) {
5931                throw e.rethrowFromSystemServer();
5932            }
5933        }
5934    }
5935
5936    /**
5937     * Called by a device admin to get the long support message.
5938     *
5939     * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
5940     * @return The message set by {@link #setLongSupportMessage(ComponentName, CharSequence)} or
5941     *         null if no message has been set.
5942     * @throws SecurityException if {@code admin} is not an active administrator.
5943     */
5944    public CharSequence getLongSupportMessage(@NonNull ComponentName admin) {
5945        throwIfParentInstance("getLongSupportMessage");
5946        if (mService != null) {
5947            try {
5948                return mService.getLongSupportMessage(admin);
5949            } catch (RemoteException e) {
5950                throw e.rethrowFromSystemServer();
5951            }
5952        }
5953        return null;
5954    }
5955
5956    /**
5957     * Called by the system to get the short support message.
5958     *
5959     * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
5960     * @param userHandle user id the admin is running as.
5961     * @return The message set by {@link #setShortSupportMessage(ComponentName, CharSequence)}
5962     *
5963     * @hide
5964     */
5965    public CharSequence getShortSupportMessageForUser(@NonNull ComponentName admin,
5966            int userHandle) {
5967        if (mService != null) {
5968            try {
5969                return mService.getShortSupportMessageForUser(admin, userHandle);
5970            } catch (RemoteException e) {
5971                throw e.rethrowFromSystemServer();
5972            }
5973        }
5974        return null;
5975    }
5976
5977
5978    /**
5979     * Called by the system to get the long support message.
5980     *
5981     * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
5982     * @param userHandle user id the admin is running as.
5983     * @return The message set by {@link #setLongSupportMessage(ComponentName, CharSequence)}
5984     *
5985     * @hide
5986     */
5987    public CharSequence getLongSupportMessageForUser(@NonNull ComponentName admin, int userHandle) {
5988        if (mService != null) {
5989            try {
5990                return mService.getLongSupportMessageForUser(admin, userHandle);
5991            } catch (RemoteException e) {
5992                throw e.rethrowFromSystemServer();
5993            }
5994        }
5995        return null;
5996    }
5997
5998    /**
5999     * Called by the profile owner of a managed profile to obtain a {@link DevicePolicyManager}
6000     * whose calls act on the parent profile.
6001     *
6002     * <p>The following methods are supported for the parent instance, all other methods will
6003     * throw a SecurityException when called on the parent instance:
6004     * <ul>
6005     * <li>{@link #getPasswordQuality}</li>
6006     * <li>{@link #setPasswordQuality}</li>
6007     * <li>{@link #getPasswordMinimumLength}</li>
6008     * <li>{@link #setPasswordMinimumLength}</li>
6009     * <li>{@link #getPasswordMinimumUpperCase}</li>
6010     * <li>{@link #setPasswordMinimumUpperCase}</li>
6011     * <li>{@link #getPasswordMinimumLowerCase}</li>
6012     * <li>{@link #setPasswordMinimumLowerCase}</li>
6013     * <li>{@link #getPasswordMinimumLetters}</li>
6014     * <li>{@link #setPasswordMinimumLetters}</li>
6015     * <li>{@link #getPasswordMinimumNumeric}</li>
6016     * <li>{@link #setPasswordMinimumNumeric}</li>
6017     * <li>{@link #getPasswordMinimumSymbols}</li>
6018     * <li>{@link #setPasswordMinimumSymbols}</li>
6019     * <li>{@link #getPasswordMinimumNonLetter}</li>
6020     * <li>{@link #setPasswordMinimumNonLetter}</li>
6021     * <li>{@link #getPasswordHistoryLength}</li>
6022     * <li>{@link #setPasswordHistoryLength}</li>
6023     * <li>{@link #getPasswordExpirationTimeout}</li>
6024     * <li>{@link #setPasswordExpirationTimeout}</li>
6025     * <li>{@link #getPasswordExpiration}</li>
6026     * <li>{@link #isActivePasswordSufficient}</li>
6027     * <li>{@link #getCurrentFailedPasswordAttempts}</li>
6028     * <li>{@link #getMaximumFailedPasswordsForWipe}</li>
6029     * <li>{@link #setMaximumFailedPasswordsForWipe}</li>
6030     * <li>{@link #getMaximumTimeToLock}</li>
6031     * <li>{@link #setMaximumTimeToLock}</li>
6032     * <li>{@link #lockNow}</li>
6033     * <li>{@link #getKeyguardDisabledFeatures}</li>
6034     * <li>{@link #setKeyguardDisabledFeatures}</li>
6035     * <li>{@link #getTrustAgentConfiguration}</li>
6036     * <li>{@link #setTrustAgentConfiguration}</li>
6037     * </ul>
6038     *
6039     * @return a new instance of {@link DevicePolicyManager} that acts on the parent profile.
6040     * @throws SecurityException if {@code admin} is not a profile owner.
6041     */
6042    public DevicePolicyManager getParentProfileInstance(@NonNull ComponentName admin) {
6043        throwIfParentInstance("getParentProfileInstance");
6044        try {
6045            if (!mService.isManagedProfile(admin)) {
6046                throw new SecurityException("The current user does not have a parent profile.");
6047            }
6048            return new DevicePolicyManager(mContext, true);
6049        } catch (RemoteException e) {
6050            throw e.rethrowFromSystemServer();
6051        }
6052    }
6053
6054    /**
6055     * Called by device owner to control the security logging feature. Logging can only be
6056     * enabled on single user devices where the sole user is managed by the device owner.
6057     *
6058     * <p> Security logs contain various information intended for security auditing purposes.
6059     * See {@link SecurityEvent} for details.
6060     *
6061     * <p>There must be only one user on the device, managed by the device owner.
6062     * Otherwise a {@link SecurityException} will be thrown.
6063     *
6064     * @param admin Which device owner this request is associated with.
6065     * @param enabled whether security logging should be enabled or not.
6066     * @throws SecurityException if {@code admin} is not a device owner.
6067     * @see #retrieveSecurityLogs
6068     */
6069    public void setSecurityLoggingEnabled(@NonNull ComponentName admin, boolean enabled) {
6070        throwIfParentInstance("setSecurityLoggingEnabled");
6071        try {
6072            mService.setSecurityLoggingEnabled(admin, enabled);
6073        } catch (RemoteException re) {
6074            throw re.rethrowFromSystemServer();
6075        }
6076    }
6077
6078    /**
6079     * Return whether security logging is enabled or not by the device owner.
6080     *
6081     * <p>Can only be called by the device owner, otherwise a {@link SecurityException} will be
6082     * thrown.
6083     *
6084     * @param admin Which device owner this request is associated with.
6085     * @return {@code true} if security logging is enabled by device owner, {@code false} otherwise.
6086     * @throws SecurityException if {@code admin} is not a device owner.
6087     */
6088    public boolean isSecurityLoggingEnabled(@NonNull ComponentName admin) {
6089        throwIfParentInstance("isSecurityLoggingEnabled");
6090        try {
6091            return mService.isSecurityLoggingEnabled(admin);
6092        } catch (RemoteException re) {
6093            throw re.rethrowFromSystemServer();
6094        }
6095    }
6096
6097    /**
6098     * Called by device owner to retrieve all new security logging entries since the last call to
6099     * this API after device boots.
6100     *
6101     * <p> Access to the logs is rate limited and it will only return new logs after the device
6102     * owner has been notified via {@link DeviceAdminReceiver#onSecurityLogsAvailable}.
6103     *
6104     * <p>There must be only one user on the device, managed by the device owner.
6105     * Otherwise a {@link SecurityException} will be thrown.
6106     *
6107     * @param admin Which device owner this request is associated with.
6108     * @return the new batch of security logs which is a list of {@link SecurityEvent},
6109     * or {@code null} if rate limitation is exceeded or if logging is currently disabled.
6110     * @throws SecurityException if {@code admin} is not a device owner.
6111     */
6112    public List<SecurityEvent> retrieveSecurityLogs(@NonNull ComponentName admin) {
6113        throwIfParentInstance("retrieveSecurityLogs");
6114        try {
6115            ParceledListSlice<SecurityEvent> list = mService.retrieveSecurityLogs(admin);
6116            if (list != null) {
6117                return list.getList();
6118            } else {
6119                // Rate limit exceeded.
6120                return null;
6121            }
6122        } catch (RemoteException re) {
6123            throw re.rethrowFromSystemServer();
6124        }
6125    }
6126
6127    /**
6128     * Called by the system to obtain a {@link DevicePolicyManager} whose calls act on the parent
6129     * profile.
6130     *
6131     * @hide
6132     */
6133    public DevicePolicyManager getParentProfileInstance(UserInfo uInfo) {
6134        mContext.checkSelfPermission(
6135                android.Manifest.permission.MANAGE_PROFILE_AND_DEVICE_OWNERS);
6136        if (!uInfo.isManagedProfile()) {
6137            throw new SecurityException("The user " + uInfo.id
6138                    + " does not have a parent profile.");
6139        }
6140        return new DevicePolicyManager(mContext, true);
6141    }
6142
6143    /**
6144     * Called by device owners to retrieve device logs from before the device's last reboot.
6145     * <p>
6146     * <strong> This API is not supported on all devices. Calling this API on unsupported devices
6147     * will result in {@code null} being returned. The device logs are retrieved from a RAM region
6148     * which is not guaranteed to be corruption-free during power cycles, as a result be cautious
6149     * about data corruption when parsing. </strong>
6150     * <p>
6151     * There must be only one user on the device, managed by the device owner. Otherwise a
6152     * {@link SecurityException} will be thrown.
6153     *
6154     * @param admin Which device owner this request is associated with.
6155     * @return Device logs from before the latest reboot of the system, or {@code null} if this API
6156     *         is not supported on the device.
6157     * @throws SecurityException if {@code admin} is not a device owner.
6158     */
6159    public List<SecurityEvent> retrievePreRebootSecurityLogs(@NonNull ComponentName admin) {
6160        throwIfParentInstance("retrievePreRebootSecurityLogs");
6161        try {
6162            ParceledListSlice<SecurityEvent> list = mService.retrievePreRebootSecurityLogs(admin);
6163            if (list != null) {
6164                return list.getList();
6165            } else {
6166                return null;
6167            }
6168        } catch (RemoteException re) {
6169            throw re.rethrowFromSystemServer();
6170        }
6171    }
6172
6173    /**
6174     * Called by a profile owner of a managed profile to set the color used for customization. This
6175     * color is used as background color of the confirm credentials screen for that user. The
6176     * default color is teal (#00796B).
6177     * <p>
6178     * The confirm credentials screen can be created using
6179     * {@link android.app.KeyguardManager#createConfirmDeviceCredentialIntent}.
6180     *
6181     * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
6182     * @param color The 24bit (0xRRGGBB) representation of the color to be used.
6183     * @throws SecurityException if {@code admin} is not a profile owner.
6184     */
6185    public void setOrganizationColor(@NonNull ComponentName admin, int color) {
6186        throwIfParentInstance("setOrganizationColor");
6187        try {
6188            // always enforce alpha channel to have 100% opacity
6189            color |= 0xFF000000;
6190            mService.setOrganizationColor(admin, color);
6191        } catch (RemoteException re) {
6192            throw re.rethrowFromSystemServer();
6193        }
6194    }
6195
6196    /**
6197     * @hide
6198     *
6199     * Sets the color used for customization.
6200     *
6201     * @param color The 24bit (0xRRGGBB) representation of the color to be used.
6202     * @param userId which user to set the color to.
6203     * @RequiresPermission(allOf = {
6204     *       Manifest.permission.MANAGE_USERS,
6205     *       Manifest.permission.INTERACT_ACROSS_USERS_FULL})
6206     */
6207    public void setOrganizationColorForUser(@ColorInt int color, @UserIdInt int userId) {
6208        try {
6209            // always enforce alpha channel to have 100% opacity
6210            color |= 0xFF000000;
6211            mService.setOrganizationColorForUser(color, userId);
6212        } catch (RemoteException re) {
6213            throw re.rethrowFromSystemServer();
6214        }
6215    }
6216
6217    /**
6218     * Called by a profile owner of a managed profile to retrieve the color used for customization.
6219     * This color is used as background color of the confirm credentials screen for that user.
6220     *
6221     * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
6222     * @return The 24bit (0xRRGGBB) representation of the color to be used.
6223     * @throws SecurityException if {@code admin} is not a profile owner.
6224     */
6225    public @ColorInt int getOrganizationColor(@NonNull ComponentName admin) {
6226        throwIfParentInstance("getOrganizationColor");
6227        try {
6228            return mService.getOrganizationColor(admin);
6229        } catch (RemoteException re) {
6230            throw re.rethrowFromSystemServer();
6231        }
6232    }
6233
6234    /**
6235     * @hide
6236     * Retrieve the customization color for a given user.
6237     *
6238     * @param userHandle The user id of the user we're interested in.
6239     * @return The 24bit (0xRRGGBB) representation of the color to be used.
6240     */
6241    public @ColorInt int getOrganizationColorForUser(int userHandle) {
6242        try {
6243            return mService.getOrganizationColorForUser(userHandle);
6244        } catch (RemoteException re) {
6245            throw re.rethrowFromSystemServer();
6246        }
6247    }
6248
6249    /**
6250     * Called by a profile owner of a managed profile to set the name of the organization under
6251     * management.
6252     * <p>
6253     * If the organization name needs to be localized, it is the responsibility of the
6254     * {@link DeviceAdminReceiver} to listen to the {@link Intent#ACTION_LOCALE_CHANGED} broadcast
6255     * and set a new version of this string accordingly.
6256     *
6257     * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
6258     * @param title The organization name or {@code null} to clear a previously set name.
6259     * @throws SecurityException if {@code admin} is not a profile owner.
6260     */
6261    public void setOrganizationName(@NonNull ComponentName admin, @Nullable CharSequence title) {
6262        throwIfParentInstance("setOrganizationName");
6263        try {
6264            mService.setOrganizationName(admin, title);
6265        } catch (RemoteException re) {
6266            throw re.rethrowFromSystemServer();
6267        }
6268    }
6269
6270    /**
6271     * Called by a profile owner of a managed profile to retrieve the name of the organization under
6272     * management.
6273     *
6274     * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
6275     * @return The organization name or {@code null} if none is set.
6276     * @throws SecurityException if {@code admin} is not a profile owner.
6277     */
6278    public CharSequence getOrganizationName(@NonNull ComponentName admin) {
6279        throwIfParentInstance("getOrganizationName");
6280        try {
6281            return mService.getOrganizationName(admin);
6282        } catch (RemoteException re) {
6283            throw re.rethrowFromSystemServer();
6284        }
6285    }
6286
6287    /**
6288     * Retrieve the default title message used in the confirm credentials screen for a given user.
6289     *
6290     * @param userHandle The user id of the user we're interested in.
6291     * @return The organization name or {@code null} if none is set.
6292     *
6293     * @hide
6294     */
6295    public CharSequence getOrganizationNameForUser(int userHandle) {
6296        try {
6297            return mService.getOrganizationNameForUser(userHandle);
6298        } catch (RemoteException re) {
6299            throw re.rethrowFromSystemServer();
6300        }
6301    }
6302
6303    /**
6304     * @return the {@link UserProvisioningState} for the current user - for unmanaged users will
6305     *         return {@link #STATE_USER_UNMANAGED}
6306     * @hide
6307     */
6308    @SystemApi
6309    @UserProvisioningState
6310    public int getUserProvisioningState() {
6311        throwIfParentInstance("getUserProvisioningState");
6312        if (mService != null) {
6313            try {
6314                return mService.getUserProvisioningState();
6315            } catch (RemoteException e) {
6316                throw e.rethrowFromSystemServer();
6317            }
6318        }
6319        return STATE_USER_UNMANAGED;
6320    }
6321
6322    /**
6323     * Set the {@link UserProvisioningState} for the supplied user, if they are managed.
6324     *
6325     * @param state to store
6326     * @param userHandle for user
6327     * @hide
6328     */
6329    public void setUserProvisioningState(@UserProvisioningState int state, int userHandle) {
6330        if (mService != null) {
6331            try {
6332                mService.setUserProvisioningState(state, userHandle);
6333            } catch (RemoteException e) {
6334                throw e.rethrowFromSystemServer();
6335            }
6336        }
6337    }
6338
6339    /**
6340     * @hide
6341     * Indicates the entity that controls the device or profile owner. A user/profile is considered
6342     * affiliated if it is managed by the same entity as the device.
6343     *
6344     * <p> By definition, the user that the device owner runs on is always affiliated. Any other
6345     * user/profile is considered affiliated if the following conditions are both met:
6346     * <ul>
6347     * <li>The device owner and the user's/profile's profile owner have called this method,
6348     *   specifying a set of opaque affiliation ids each. If the sets specified by the device owner
6349     *   and a profile owner intersect, they must have come from the same source, which means that
6350     *   the device owner and profile owner are controlled by the same entity.</li>
6351     * <li>The device owner's and profile owner's package names are the same.</li>
6352     * </ul>
6353     *
6354     * @param admin Which profile or device owner this request is associated with.
6355     * @param ids A set of opaque affiliation ids.
6356     */
6357    public void setAffiliationIds(@NonNull ComponentName admin, Set<String> ids) {
6358        throwIfParentInstance("setAffiliationIds");
6359        try {
6360            mService.setAffiliationIds(admin, new ArrayList<String>(ids));
6361        } catch (RemoteException e) {
6362            throw e.rethrowFromSystemServer();
6363        }
6364    }
6365
6366    /**
6367     * @hide
6368     * Returns whether this user/profile is affiliated with the device. See
6369     * {@link #setAffiliationIds} for the definition of affiliation.
6370     *
6371     * @return whether this user/profile is affiliated with the device.
6372     */
6373    public boolean isAffiliatedUser() {
6374        throwIfParentInstance("isAffiliatedUser");
6375        try {
6376            return mService != null && mService.isAffiliatedUser();
6377        } catch (RemoteException e) {
6378            throw e.rethrowFromSystemServer();
6379        }
6380    }
6381
6382    /**
6383     * @hide
6384     * Returns whether the uninstall for {@code packageName} for the current user is in queue
6385     * to be started
6386     * @param packageName the package to check for
6387     * @return whether the uninstall intent for {@code packageName} is pending
6388     */
6389    public boolean isUninstallInQueue(String packageName) {
6390        try {
6391            return mService.isUninstallInQueue(packageName);
6392        } catch (RemoteException re) {
6393            throw re.rethrowFromSystemServer();
6394        }
6395    }
6396
6397    /**
6398     * @hide
6399     * @param packageName the package containing active DAs to be uninstalled
6400     */
6401    public void uninstallPackageWithActiveAdmins(String packageName) {
6402        try {
6403            mService.uninstallPackageWithActiveAdmins(packageName);
6404        } catch (RemoteException re) {
6405            throw re.rethrowFromSystemServer();
6406        }
6407    }
6408
6409    /**
6410     * @hide
6411     * Remove a test admin synchronously without sending it a broadcast about being removed.
6412     * If the admin is a profile owner or device owner it will still be removed.
6413     *
6414     * @param userHandle user id to remove the admin for.
6415     * @param admin The administration compononent to remove.
6416     * @throws SecurityException if the caller is not shell / root or the admin package
6417     *         isn't a test application see {@link ApplicationInfo#FLAG_TEST_APP}.
6418     */
6419    public void forceRemoveActiveAdmin(ComponentName adminReceiver, int userHandle) {
6420        try {
6421            mService.forceRemoveActiveAdmin(adminReceiver, userHandle);
6422        } catch (RemoteException re) {
6423            throw re.rethrowFromSystemServer();
6424        }
6425    }
6426
6427    /**
6428     * @hide
6429     * @return whether {@link android.provider.Settings.Global#DEVICE_PROVISIONED} has ever been set
6430     * to 1.
6431     */
6432    public boolean isDeviceProvisioned() {
6433        try {
6434            return mService.isDeviceProvisioned();
6435        } catch (RemoteException re) {
6436            throw re.rethrowFromSystemServer();
6437        }
6438    }
6439
6440    /**
6441     * @hide
6442     * Writes that the provisioning configuration has been applied.
6443     */
6444    public void setDeviceProvisioningConfigApplied() {
6445        try {
6446            mService.setDeviceProvisioningConfigApplied();
6447        } catch (RemoteException re) {
6448            throw re.rethrowFromSystemServer();
6449        }
6450    }
6451
6452    /**
6453     * @hide
6454     * @return whether the provisioning configuration has been applied.
6455     */
6456    public boolean isDeviceProvisioningConfigApplied() {
6457        try {
6458            return mService.isDeviceProvisioningConfigApplied();
6459        } catch (RemoteException re) {
6460            throw re.rethrowFromSystemServer();
6461        }
6462    }
6463
6464    private void throwIfParentInstance(String functionName) {
6465        if (mParentInstance) {
6466            throw new SecurityException(functionName + " cannot be called on the parent instance");
6467        }
6468    }
6469}
6470