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