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