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