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