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