DevicePolicyManager.java revision f8f56bce428bb2b89d1d572ccd2d604761dbbce8
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.SdkConstant;
20import android.annotation.SdkConstant.SdkConstantType;
21import android.annotation.SystemApi;
22import android.app.Activity;
23import android.app.admin.IDevicePolicyManager;
24import android.content.ComponentName;
25import android.content.Context;
26import android.content.Intent;
27import android.content.IntentFilter;
28import android.content.pm.ActivityInfo;
29import android.content.pm.PackageManager;
30import android.content.pm.ResolveInfo;
31import android.net.ProxyInfo;
32import android.os.Bundle;
33import android.os.Handler;
34import android.os.PersistableBundle;
35import android.os.Process;
36import android.os.RemoteCallback;
37import android.os.RemoteException;
38import android.os.ServiceManager;
39import android.os.UserHandle;
40import android.os.UserManager;
41import android.provider.Settings;
42import android.security.Credentials;
43import android.service.restrictions.RestrictionsReceiver;
44import android.service.trust.TrustAgentService;
45import android.util.Log;
46
47import com.android.org.conscrypt.TrustedCertificateStore;
48
49import org.xmlpull.v1.XmlPullParserException;
50
51import java.io.ByteArrayInputStream;
52import java.io.IOException;
53import java.net.InetSocketAddress;
54import java.net.Proxy;
55import java.security.PrivateKey;
56import java.security.cert.Certificate;
57import java.security.cert.CertificateException;
58import java.security.cert.CertificateFactory;
59import java.security.cert.X509Certificate;
60import java.util.ArrayList;
61import java.util.Collections;
62import java.util.List;
63
64/**
65 * Public interface for managing policies enforced on a device. Most clients of this class must be
66 * registered with the system as a
67 * <a href={@docRoot}guide/topics/admin/device-admin.html">device administrator</a>. Additionally,
68 * a device administrator may be registered as either a profile or device owner. A given method is
69 * accessible to all device administrators unless the documentation for that method specifies that
70 * it is restricted to either device or profile owners.
71 *
72 * <div class="special reference">
73 * <h3>Developer Guides</h3>
74 * <p>For more information about managing policies for device administration, read the
75 * <a href="{@docRoot}guide/topics/admin/device-admin.html">Device Administration</a>
76 * developer guide.</p>
77 * </div>
78 */
79public class DevicePolicyManager {
80    private static String TAG = "DevicePolicyManager";
81
82    private final Context mContext;
83    private final IDevicePolicyManager mService;
84
85    private DevicePolicyManager(Context context, Handler handler) {
86        mContext = context;
87        mService = IDevicePolicyManager.Stub.asInterface(
88                ServiceManager.getService(Context.DEVICE_POLICY_SERVICE));
89    }
90
91    /** @hide */
92    public static DevicePolicyManager create(Context context, Handler handler) {
93        DevicePolicyManager me = new DevicePolicyManager(context, handler);
94        return me.mService != null ? me : null;
95    }
96
97    /**
98     * Activity action: Starts the provisioning flow which sets up a managed profile.
99     *
100     * <p>A managed profile allows data separation for example for the usage of a
101     * device as a personal and corporate device. The user which provisioning is started from and
102     * the managed profile share a launcher.
103     *
104     * <p>This intent will typically be sent by a mobile device management application (mdm).
105     * Provisioning adds a managed profile and sets the mdm as the profile owner who has full
106     * control over the profile
107     *
108     * <p>This intent must contain the extra {@link #EXTRA_PROVISIONING_DEVICE_ADMIN_PACKAGE_NAME}.
109     *
110     * <p> When managed provisioning has completed, an intent of the type
111     * {@link DeviceAdminReceiver#ACTION_PROFILE_PROVISIONING_COMPLETE} is broadcasted to the
112     * managed profile.
113     *
114     * <p> If provisioning fails, the managedProfile is removed so the device returns to its
115     * previous state.
116     *
117     * <p>Input: Nothing.</p>
118     * <p>Output: Nothing</p>
119     */
120    @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
121    public static final String ACTION_PROVISION_MANAGED_PROFILE
122        = "android.app.action.PROVISION_MANAGED_PROFILE";
123
124    /**
125     * A {@link android.os.Parcelable} extra of type {@link android.os.PersistableBundle} that allows
126     * a mobile device management application that starts managed profile provisioning to pass data
127     * to itself on the managed profile when provisioning completes. The mobile device management
128     * application sends this extra in an intent with the action
129     * {@link #ACTION_PROVISION_MANAGED_PROFILE} and receives it in
130     * {@link DeviceAdminReceiver#onProfileProvisioningComplete} via an intent with the action
131     * {@link DeviceAdminReceiver#ACTION_PROFILE_PROVISIONING_COMPLETE}. The bundle is not changed
132     * during the managed profile provisioning.
133     */
134    public static final String EXTRA_PROVISIONING_ADMIN_EXTRAS_BUNDLE =
135            "android.app.extra.PROVISIONING_ADMIN_EXTRAS_BUNDLE";
136
137    /**
138     * A String extra holding the package name of the mobile device management application that
139     * will be set as the profile owner or device owner.
140     *
141     * <p>If an application starts provisioning directly via an intent with action
142     * {@link #ACTION_PROVISION_MANAGED_PROFILE} this package has to match the package name of the
143     * application that started provisioning. The package will be set as profile owner in that case.
144     *
145     * <p>This package is set as device owner when device owner provisioning is started by an NFC
146     * message containing an NFC record with MIME type {@link #MIME_TYPE_PROVISIONING_NFC}.
147     */
148    public static final String EXTRA_PROVISIONING_DEVICE_ADMIN_PACKAGE_NAME
149        = "android.app.extra.PROVISIONING_DEVICE_ADMIN_PACKAGE_NAME";
150
151    /**
152     * An {@link android.accounts.Account} extra holding the account to migrate during managed
153     * profile provisioning. If the account supplied is present in the primary user, it will be
154     * copied, along with its credentials to the managed profile and removed from the primary user.
155     *
156     * Use with {@link #ACTION_PROVISION_MANAGED_PROFILE}.
157     */
158
159    public static final String EXTRA_PROVISIONING_ACCOUNT_TO_MIGRATE
160        = "android.app.extra.PROVISIONING_ACCOUNT_TO_MIGRATE";
161
162    /**
163     * A String extra that, holds the email address of the account which a managed profile is
164     * created for. Used with {@link #ACTION_PROVISION_MANAGED_PROFILE} and
165     * {@link DeviceAdminReceiver#ACTION_PROFILE_PROVISIONING_COMPLETE}.
166     *
167     * <p> This extra is part of the {@link #EXTRA_PROVISIONING_ADMIN_EXTRAS_BUNDLE}.
168     *
169     * <p> If the {@link #ACTION_PROVISION_MANAGED_PROFILE} intent that starts managed provisioning
170     * contains this extra, it is forwarded in the
171     * {@link DeviceAdminReceiver#ACTION_PROFILE_PROVISIONING_COMPLETE} intent to the mobile
172     * device management application that was set as the profile owner during provisioning.
173     * It is usually used to avoid that the user has to enter their email address twice.
174     */
175    public static final String EXTRA_PROVISIONING_EMAIL_ADDRESS
176        = "android.app.extra.PROVISIONING_EMAIL_ADDRESS";
177
178    /**
179     * A Boolean extra that can be used by the mobile device management application to skip the
180     * disabling of system apps during provisioning when set to <code>true</code>.
181     *
182     * <p>Use in an NFC record with {@link #MIME_TYPE_PROVISIONING_NFC} that starts device owner
183     * provisioning via an NFC bump.
184     */
185    public static final String EXTRA_PROVISIONING_DONT_DISABLE_SYSTEM_APPS =
186            "android.app.extra.PROVISIONING_DONT_DISABLE_SYSTEM_APPS";
187
188    /**
189     * A String extra holding the time zone {@link android.app.AlarmManager} that the device
190     * will be set to.
191     *
192     * <p>Use in an NFC record with {@link #MIME_TYPE_PROVISIONING_NFC} that starts device owner
193     * provisioning via an NFC bump.
194     */
195    public static final String EXTRA_PROVISIONING_TIME_ZONE
196        = "android.app.extra.PROVISIONING_TIME_ZONE";
197
198    /**
199     * A Long extra holding the wall clock time (in milliseconds) to be set on the device's
200     * {@link android.app.AlarmManager}.
201     *
202     * <p>Use in an NFC record with {@link #MIME_TYPE_PROVISIONING_NFC} that starts device owner
203     * provisioning via an NFC bump.
204     */
205    public static final String EXTRA_PROVISIONING_LOCAL_TIME
206        = "android.app.extra.PROVISIONING_LOCAL_TIME";
207
208    /**
209     * A String extra holding the {@link java.util.Locale} that the device will be set to.
210     * Format: xx_yy, where xx is the language code, and yy the country code.
211     *
212     * <p>Use in an NFC record with {@link #MIME_TYPE_PROVISIONING_NFC} that starts device owner
213     * provisioning via an NFC bump.
214     */
215    public static final String EXTRA_PROVISIONING_LOCALE
216        = "android.app.extra.PROVISIONING_LOCALE";
217
218    /**
219     * A String extra holding the ssid of the wifi network that should be used during nfc device
220     * owner provisioning for downloading the mobile device management application.
221     *
222     * <p>Use in an NFC record with {@link #MIME_TYPE_PROVISIONING_NFC} that starts device owner
223     * provisioning via an NFC bump.
224     */
225    public static final String EXTRA_PROVISIONING_WIFI_SSID
226        = "android.app.extra.PROVISIONING_WIFI_SSID";
227
228    /**
229     * A boolean extra indicating whether the wifi network in {@link #EXTRA_PROVISIONING_WIFI_SSID}
230     * is hidden or not.
231     *
232     * <p>Use in an NFC record with {@link #MIME_TYPE_PROVISIONING_NFC} that starts device owner
233     * provisioning via an NFC bump.
234     */
235    public static final String EXTRA_PROVISIONING_WIFI_HIDDEN
236        = "android.app.extra.PROVISIONING_WIFI_HIDDEN";
237
238    /**
239     * A String extra indicating the security type of the wifi network in
240     * {@link #EXTRA_PROVISIONING_WIFI_SSID}.
241     *
242     * <p>Use in an NFC record with {@link #MIME_TYPE_PROVISIONING_NFC} that starts device owner
243     * provisioning via an NFC bump.
244     */
245    public static final String EXTRA_PROVISIONING_WIFI_SECURITY_TYPE
246        = "android.app.extra.PROVISIONING_WIFI_SECURITY_TYPE";
247
248    /**
249     * A String extra holding the password of the wifi network in
250     * {@link #EXTRA_PROVISIONING_WIFI_SSID}.
251     *
252     * <p>Use in an NFC record with {@link #MIME_TYPE_PROVISIONING_NFC} that starts device owner
253     * provisioning via an NFC bump.
254     */
255    public static final String EXTRA_PROVISIONING_WIFI_PASSWORD
256        = "android.app.extra.PROVISIONING_WIFI_PASSWORD";
257
258    /**
259     * A String extra holding the proxy host for the wifi network in
260     * {@link #EXTRA_PROVISIONING_WIFI_SSID}.
261     *
262     * <p>Use in an NFC record with {@link #MIME_TYPE_PROVISIONING_NFC} that starts device owner
263     * provisioning via an NFC bump.
264     */
265    public static final String EXTRA_PROVISIONING_WIFI_PROXY_HOST
266        = "android.app.extra.PROVISIONING_WIFI_PROXY_HOST";
267
268    /**
269     * An int extra holding the proxy port for the wifi network in
270     * {@link #EXTRA_PROVISIONING_WIFI_SSID}.
271     *
272     * <p>Use in an NFC record with {@link #MIME_TYPE_PROVISIONING_NFC} that starts device owner
273     * provisioning via an NFC bump.
274     */
275    public static final String EXTRA_PROVISIONING_WIFI_PROXY_PORT
276        = "android.app.extra.PROVISIONING_WIFI_PROXY_PORT";
277
278    /**
279     * A String extra holding the proxy bypass for the wifi network in
280     * {@link #EXTRA_PROVISIONING_WIFI_SSID}.
281     *
282     * <p>Use in an NFC record with {@link #MIME_TYPE_PROVISIONING_NFC} that starts device owner
283     * provisioning via an NFC bump.
284     */
285    public static final String EXTRA_PROVISIONING_WIFI_PROXY_BYPASS
286        = "android.app.extra.PROVISIONING_WIFI_PROXY_BYPASS";
287
288    /**
289     * A String extra holding the proxy auto-config (PAC) URL for the wifi network in
290     * {@link #EXTRA_PROVISIONING_WIFI_SSID}.
291     *
292     * <p>Use in an NFC record with {@link #MIME_TYPE_PROVISIONING_NFC} that starts device owner
293     * provisioning via an NFC bump.
294     */
295    public static final String EXTRA_PROVISIONING_WIFI_PAC_URL
296        = "android.app.extra.PROVISIONING_WIFI_PAC_URL";
297
298    /**
299     * A String extra holding a url that specifies the download location of the device admin
300     * package. When not provided it is assumed that the device admin package is already installed.
301     *
302     * <p>Use in an NFC record with {@link #MIME_TYPE_PROVISIONING_NFC} that starts device owner
303     * provisioning via an NFC bump.
304     */
305    public static final String EXTRA_PROVISIONING_DEVICE_ADMIN_PACKAGE_DOWNLOAD_LOCATION
306        = "android.app.extra.PROVISIONING_DEVICE_ADMIN_PACKAGE_DOWNLOAD_LOCATION";
307
308    /**
309     * A String extra holding a http cookie header which should be used in the http request to the
310     * url specified in {@link #EXTRA_PROVISIONING_DEVICE_ADMIN_PACKAGE_DOWNLOAD_LOCATION}.
311     *
312     * <p>Use in an NFC record with {@link #MIME_TYPE_PROVISIONING_NFC} that starts device owner
313     * provisioning via an NFC bump.
314     */
315    public static final String EXTRA_PROVISIONING_DEVICE_ADMIN_PACKAGE_DOWNLOAD_COOKIE_HEADER
316        = "android.app.extra.PROVISIONING_DEVICE_ADMIN_PACKAGE_DOWNLOAD_COOKIE_HEADER";
317
318    /**
319     * A String extra holding the SHA-1 checksum of the file at download location specified in
320     * {@link #EXTRA_PROVISIONING_DEVICE_ADMIN_PACKAGE_DOWNLOAD_LOCATION}. If this doesn't match
321     * the file at the download location an error will be shown to the user and the user will be
322     * asked to factory reset the device.
323     *
324     * <p>Use in an NFC record with {@link #MIME_TYPE_PROVISIONING_NFC} that starts device owner
325     * provisioning via an NFC bump.
326     */
327    public static final String EXTRA_PROVISIONING_DEVICE_ADMIN_PACKAGE_CHECKSUM
328        = "android.app.extra.PROVISIONING_DEVICE_ADMIN_PACKAGE_CHECKSUM";
329
330    /**
331     * This MIME type is used for starting the Device Owner provisioning.
332     *
333     * <p>During device owner provisioning a device admin app is set as the owner of the device.
334     * A device owner has full control over the device. The device owner can not be modified by the
335     * user and the only way of resetting the device is if the device owner app calls a factory
336     * reset.
337     *
338     * <p> A typical use case would be a device that is owned by a company, but used by either an
339     * employee or client.
340     *
341     * <p> The NFC message should be send to an unprovisioned device.
342     *
343     * <p>The NFC record must contain a serialized {@link java.util.Properties} object which
344     * contains the following properties:
345     * <ul>
346     * <li>{@link #EXTRA_PROVISIONING_DEVICE_ADMIN_PACKAGE_NAME}</li>
347     * <li>{@link #EXTRA_PROVISIONING_DEVICE_ADMIN_PACKAGE_DOWNLOAD_LOCATION}</li>
348     * <li>{@link #EXTRA_PROVISIONING_DEVICE_ADMIN_PACKAGE_DOWNLOAD_COOKIE_HEADER}, optional</li>
349     * <li>{@link #EXTRA_PROVISIONING_DEVICE_ADMIN_PACKAGE_CHECKSUM}</li>
350     * <li>{@link #EXTRA_PROVISIONING_LOCAL_TIME} (convert to String), optional</li>
351     * <li>{@link #EXTRA_PROVISIONING_TIME_ZONE}, optional</li>
352     * <li>{@link #EXTRA_PROVISIONING_LOCALE}, optional</li>
353     * <li>{@link #EXTRA_PROVISIONING_WIFI_SSID}, optional</li>
354     * <li>{@link #EXTRA_PROVISIONING_WIFI_HIDDEN} (convert to String), optional</li>
355     * <li>{@link #EXTRA_PROVISIONING_WIFI_SECURITY_TYPE}, optional</li>
356     * <li>{@link #EXTRA_PROVISIONING_WIFI_PASSWORD}, optional</li>
357     * <li>{@link #EXTRA_PROVISIONING_WIFI_PROXY_HOST}, optional</li>
358     * <li>{@link #EXTRA_PROVISIONING_WIFI_PROXY_PORT} (convert to String), optional</li>
359     * <li>{@link #EXTRA_PROVISIONING_WIFI_PROXY_BYPASS}, optional</li>
360     * <li>{@link #EXTRA_PROVISIONING_WIFI_PAC_URL}, optional</li></ul>
361     *
362     * <p> When device owner provisioning has completed, an intent of the type
363     * {@link DeviceAdminReceiver#ACTION_PROFILE_PROVISIONING_COMPLETE} is broadcasted to the
364     * device owner.
365     *
366     * <p>
367     * If provisioning fails, the device is factory reset.
368     *
369     * <p>Input: Nothing.</p>
370     * <p>Output: Nothing</p>
371     */
372    public static final String MIME_TYPE_PROVISIONING_NFC
373        = "application/com.android.managedprovisioning";
374
375    /**
376     * Activity action: ask the user to add a new device administrator to the system.
377     * The desired policy is the ComponentName of the policy in the
378     * {@link #EXTRA_DEVICE_ADMIN} extra field.  This will invoke a UI to
379     * bring the user through adding the device administrator to the system (or
380     * allowing them to reject it).
381     *
382     * <p>You can optionally include the {@link #EXTRA_ADD_EXPLANATION}
383     * field to provide the user with additional explanation (in addition
384     * to your component's description) about what is being added.
385     *
386     * <p>If your administrator is already active, this will ordinarily return immediately (without
387     * user intervention).  However, if your administrator has been updated and is requesting
388     * additional uses-policy flags, the user will be presented with the new list.  New policies
389     * will not be available to the updated administrator until the user has accepted the new list.
390     */
391    @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
392    public static final String ACTION_ADD_DEVICE_ADMIN
393            = "android.app.action.ADD_DEVICE_ADMIN";
394
395    /**
396     * @hide
397     * Activity action: ask the user to add a new device administrator as the profile owner
398     * for this user. Only system privileged apps that have MANAGE_USERS and MANAGE_DEVICE_ADMINS
399     * permission can call this API.
400     *
401     * <p>The ComponentName of the profile owner admin is pass in {@link #EXTRA_DEVICE_ADMIN} extra
402     * field. This will invoke a UI to bring the user through adding the profile owner admin
403     * to remotely control restrictions on the user.
404     *
405     * <p>The intent must be invoked via {@link Activity#startActivityForResult()} to receive the
406     * result of whether or not the user approved the action. If approved, the result will
407     * be {@link Activity#RESULT_OK} and the component will be set as an active admin as well
408     * as a profile owner.
409     *
410     * <p>You can optionally include the {@link #EXTRA_ADD_EXPLANATION}
411     * field to provide the user with additional explanation (in addition
412     * to your component's description) about what is being added.
413     *
414     * <p>If there is already a profile owner active or the caller doesn't have the required
415     * permissions, the operation will return a failure result.
416     */
417    @SystemApi
418    public static final String ACTION_SET_PROFILE_OWNER
419            = "android.app.action.SET_PROFILE_OWNER";
420
421    /**
422     * @hide
423     * Name of the profile owner admin that controls the user.
424     */
425    @SystemApi
426    public static final String EXTRA_PROFILE_OWNER_NAME
427            = "android.app.extra.PROFILE_OWNER_NAME";
428
429    /**
430     * Activity action: send when any policy admin changes a policy.
431     * This is generally used to find out when a new policy is in effect.
432     *
433     * @hide
434     */
435    public static final String ACTION_DEVICE_POLICY_MANAGER_STATE_CHANGED
436            = "android.app.action.DEVICE_POLICY_MANAGER_STATE_CHANGED";
437
438    /**
439     * The ComponentName of the administrator component.
440     *
441     * @see #ACTION_ADD_DEVICE_ADMIN
442     */
443    public static final String EXTRA_DEVICE_ADMIN = "android.app.extra.DEVICE_ADMIN";
444
445    /**
446     * An optional CharSequence providing additional explanation for why the
447     * admin is being added.
448     *
449     * @see #ACTION_ADD_DEVICE_ADMIN
450     */
451    public static final String EXTRA_ADD_EXPLANATION = "android.app.extra.ADD_EXPLANATION";
452
453    /**
454     * Activity action: have the user enter a new password. This activity should
455     * be launched after using {@link #setPasswordQuality(ComponentName, int)},
456     * or {@link #setPasswordMinimumLength(ComponentName, int)} to have the user
457     * enter a new password that meets the current requirements. You can use
458     * {@link #isActivePasswordSufficient()} to determine whether you need to
459     * have the user select a new password in order to meet the current
460     * constraints. Upon being resumed from this activity, you can check the new
461     * password characteristics to see if they are sufficient.
462     */
463    @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
464    public static final String ACTION_SET_NEW_PASSWORD
465            = "android.app.action.SET_NEW_PASSWORD";
466
467    /**
468     * Flag used by {@link #addCrossProfileIntentFilter} to allow access
469     * <em>from</em> a managed profile <em>to</em> its parent. That is, any
470     * matching activities in the parent profile are included in the
471     * disambiguation list shown when an app in the managed profile calls
472     * {@link Activity#startActivity(Intent)}.
473     */
474    public static final int FLAG_PARENT_CAN_ACCESS_MANAGED = 0x0001;
475
476    /**
477     * Flag used by {@link #addCrossProfileIntentFilter} to allow access
478     * <em>from</em> a parent <em>to</em> its managed profile. That is, any
479     * matching activities in the managed profile are included in the
480     * disambiguation list shown when an app in the parent profile calls
481     * {@link Activity#startActivity(Intent)}.
482     */
483    public static final int FLAG_MANAGED_CAN_ACCESS_PARENT = 0x0002;
484
485    /**
486     * Return true if the given administrator component is currently
487     * active (enabled) in the system.
488     */
489    public boolean isAdminActive(ComponentName who) {
490        return isAdminActiveAsUser(who, UserHandle.myUserId());
491    }
492
493    /**
494     * @see #isAdminActive(ComponentName)
495     * @hide
496     */
497    public boolean isAdminActiveAsUser(ComponentName who, int userId) {
498        if (mService != null) {
499            try {
500                return mService.isAdminActive(who, userId);
501            } catch (RemoteException e) {
502                Log.w(TAG, "Failed talking with device policy service", e);
503            }
504        }
505        return false;
506    }
507
508    /**
509     * Return a list of all currently active device administrator's component
510     * names.  Note that if there are no administrators than null may be
511     * returned.
512     */
513    public List<ComponentName> getActiveAdmins() {
514        return getActiveAdminsAsUser(UserHandle.myUserId());
515    }
516
517    /**
518     * @see #getActiveAdmins()
519     * @hide
520     */
521    public List<ComponentName> getActiveAdminsAsUser(int userId) {
522        if (mService != null) {
523            try {
524                return mService.getActiveAdmins(userId);
525            } catch (RemoteException e) {
526                Log.w(TAG, "Failed talking with device policy service", e);
527            }
528        }
529        return null;
530    }
531
532    /**
533     * Used by package administration code to determine if a package can be stopped
534     * or uninstalled.
535     * @hide
536     */
537    public boolean packageHasActiveAdmins(String packageName) {
538        if (mService != null) {
539            try {
540                return mService.packageHasActiveAdmins(packageName, UserHandle.myUserId());
541            } catch (RemoteException e) {
542                Log.w(TAG, "Failed talking with device policy service", e);
543            }
544        }
545        return false;
546    }
547
548    /**
549     * Remove a current administration component.  This can only be called
550     * by the application that owns the administration component; if you
551     * try to remove someone else's component, a security exception will be
552     * thrown.
553     */
554    public void removeActiveAdmin(ComponentName who) {
555        if (mService != null) {
556            try {
557                mService.removeActiveAdmin(who, UserHandle.myUserId());
558            } catch (RemoteException e) {
559                Log.w(TAG, "Failed talking with device policy service", e);
560            }
561        }
562    }
563
564    /**
565     * Returns true if an administrator has been granted a particular device policy.  This can
566     * be used to check if the administrator was activated under an earlier set of policies,
567     * but requires additional policies after an upgrade.
568     *
569     * @param admin Which {@link DeviceAdminReceiver} this request is associated with.  Must be
570     * an active administrator, or an exception will be thrown.
571     * @param usesPolicy Which uses-policy to check, as defined in {@link DeviceAdminInfo}.
572     */
573    public boolean hasGrantedPolicy(ComponentName admin, int usesPolicy) {
574        if (mService != null) {
575            try {
576                return mService.hasGrantedPolicy(admin, usesPolicy, UserHandle.myUserId());
577            } catch (RemoteException e) {
578                Log.w(TAG, "Failed talking with device policy service", e);
579            }
580        }
581        return false;
582    }
583
584    /**
585     * Constant for {@link #setPasswordQuality}: the policy has no requirements
586     * for the password.  Note that quality constants are ordered so that higher
587     * values are more restrictive.
588     */
589    public static final int PASSWORD_QUALITY_UNSPECIFIED = 0;
590
591    /**
592     * Constant for {@link #setPasswordQuality}: the policy allows for low-security biometric
593     * recognition technology.  This implies technologies that can recognize the identity of
594     * an individual to about a 3 digit PIN (false detection is less than 1 in 1,000).
595     * Note that quality constants are ordered so that higher values are more restrictive.
596     */
597    public static final int PASSWORD_QUALITY_BIOMETRIC_WEAK = 0x8000;
598
599    /**
600     * Constant for {@link #setPasswordQuality}: the policy requires some kind
601     * of password, but doesn't care what it is.  Note that quality constants
602     * are ordered so that higher values are more restrictive.
603     */
604    public static final int PASSWORD_QUALITY_SOMETHING = 0x10000;
605
606    /**
607     * Constant for {@link #setPasswordQuality}: the user must have entered a
608     * password containing at least numeric characters.  Note that quality
609     * constants are ordered so that higher values are more restrictive.
610     */
611    public static final int PASSWORD_QUALITY_NUMERIC = 0x20000;
612
613    /**
614     * Constant for {@link #setPasswordQuality}: the user must have entered a
615     * password containing at least numeric characters with no repeating (4444)
616     * or ordered (1234, 4321, 2468) sequences.  Note that quality
617     * constants are ordered so that higher values are more restrictive.
618     */
619    public static final int PASSWORD_QUALITY_NUMERIC_COMPLEX = 0x30000;
620
621    /**
622     * Constant for {@link #setPasswordQuality}: the user must have entered a
623     * password containing at least alphabetic (or other symbol) characters.
624     * Note that quality constants are ordered so that higher values are more
625     * restrictive.
626     */
627    public static final int PASSWORD_QUALITY_ALPHABETIC = 0x40000;
628
629    /**
630     * Constant for {@link #setPasswordQuality}: the user must have entered a
631     * password containing at least <em>both></em> numeric <em>and</em>
632     * alphabetic (or other symbol) characters.  Note that quality constants are
633     * ordered so that higher values are more restrictive.
634     */
635    public static final int PASSWORD_QUALITY_ALPHANUMERIC = 0x50000;
636
637    /**
638     * Constant for {@link #setPasswordQuality}: the user must have entered a
639     * password containing at least a letter, a numerical digit and a special
640     * symbol, by default. With this password quality, passwords can be
641     * restricted to contain various sets of characters, like at least an
642     * uppercase letter, etc. These are specified using various methods,
643     * like {@link #setPasswordMinimumLowerCase(ComponentName, int)}. Note
644     * that quality constants are ordered so that higher values are more
645     * restrictive.
646     */
647    public static final int PASSWORD_QUALITY_COMPLEX = 0x60000;
648
649    /**
650     * Called by an application that is administering the device to set the
651     * password restrictions it is imposing.  After setting this, the user
652     * will not be able to enter a new password that is not at least as
653     * restrictive as what has been set.  Note that the current password
654     * will remain until the user has set a new one, so the change does not
655     * take place immediately.  To prompt the user for a new password, use
656     * {@link #ACTION_SET_NEW_PASSWORD} after setting this value.
657     *
658     * <p>Quality constants are ordered so that higher values are more restrictive;
659     * thus the highest requested quality constant (between the policy set here,
660     * the user's preference, and any other considerations) is the one that
661     * is in effect.
662     *
663     * <p>The calling device admin must have requested
664     * {@link DeviceAdminInfo#USES_POLICY_LIMIT_PASSWORD} to be able to call
665     * this method; if it has not, a security exception will be thrown.
666     *
667     * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
668     * @param quality The new desired quality.  One of
669     * {@link #PASSWORD_QUALITY_UNSPECIFIED}, {@link #PASSWORD_QUALITY_SOMETHING},
670     * {@link #PASSWORD_QUALITY_NUMERIC}, {@link #PASSWORD_QUALITY_NUMERIC_COMPLEX},
671     * {@link #PASSWORD_QUALITY_ALPHABETIC}, {@link #PASSWORD_QUALITY_ALPHANUMERIC}
672     * or {@link #PASSWORD_QUALITY_COMPLEX}.
673     */
674    public void setPasswordQuality(ComponentName admin, int quality) {
675        if (mService != null) {
676            try {
677                mService.setPasswordQuality(admin, quality, UserHandle.myUserId());
678            } catch (RemoteException e) {
679                Log.w(TAG, "Failed talking with device policy service", e);
680            }
681        }
682    }
683
684    /**
685     * Retrieve the current minimum password quality for all admins of this user
686     * and its profiles or a particular one.
687     * @param admin The name of the admin component to check, or null to aggregate
688     * all admins.
689     */
690    public int getPasswordQuality(ComponentName admin) {
691        return getPasswordQuality(admin, UserHandle.myUserId());
692    }
693
694    /** @hide per-user version */
695    public int getPasswordQuality(ComponentName admin, int userHandle) {
696        if (mService != null) {
697            try {
698                return mService.getPasswordQuality(admin, userHandle);
699            } catch (RemoteException e) {
700                Log.w(TAG, "Failed talking with device policy service", e);
701            }
702        }
703        return PASSWORD_QUALITY_UNSPECIFIED;
704    }
705
706    /**
707     * Called by an application that is administering the device to set the
708     * minimum allowed password length.  After setting this, the user
709     * will not be able to enter a new password that is not at least as
710     * restrictive as what has been set.  Note that the current password
711     * will remain until the user has set a new one, so the change does not
712     * take place immediately.  To prompt the user for a new password, use
713     * {@link #ACTION_SET_NEW_PASSWORD} after setting this value.  This
714     * constraint is only imposed if the administrator has also requested either
715     * {@link #PASSWORD_QUALITY_NUMERIC}, {@link #PASSWORD_QUALITY_NUMERIC_COMPLEX},
716     * {@link #PASSWORD_QUALITY_ALPHABETIC}, {@link #PASSWORD_QUALITY_ALPHANUMERIC},
717     * or {@link #PASSWORD_QUALITY_COMPLEX} with {@link #setPasswordQuality}.
718     *
719     * <p>The calling device admin must have requested
720     * {@link DeviceAdminInfo#USES_POLICY_LIMIT_PASSWORD} to be able to call
721     * this method; if it has not, a security exception will be thrown.
722     *
723     * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
724     * @param length The new desired minimum password length.  A value of 0
725     * means there is no restriction.
726     */
727    public void setPasswordMinimumLength(ComponentName admin, int length) {
728        if (mService != null) {
729            try {
730                mService.setPasswordMinimumLength(admin, length, UserHandle.myUserId());
731            } catch (RemoteException e) {
732                Log.w(TAG, "Failed talking with device policy service", e);
733            }
734        }
735    }
736
737    /**
738     * Retrieve the current minimum password length for all admins of this
739     * user and its profiles or a particular one.
740     * @param admin The name of the admin component to check, or null to aggregate
741     * all admins.
742     */
743    public int getPasswordMinimumLength(ComponentName admin) {
744        return getPasswordMinimumLength(admin, UserHandle.myUserId());
745    }
746
747    /** @hide per-user version */
748    public int getPasswordMinimumLength(ComponentName admin, int userHandle) {
749        if (mService != null) {
750            try {
751                return mService.getPasswordMinimumLength(admin, userHandle);
752            } catch (RemoteException e) {
753                Log.w(TAG, "Failed talking with device policy service", e);
754            }
755        }
756        return 0;
757    }
758
759    /**
760     * Called by an application that is administering the device to set the
761     * minimum number of upper case letters required in the password. After
762     * setting this, the user will not be able to enter a new password that is
763     * not at least as restrictive as what has been set. Note that the current
764     * password will remain until the user has set a new one, so the change does
765     * not take place immediately. To prompt the user for a new password, use
766     * {@link #ACTION_SET_NEW_PASSWORD} after setting this value. This
767     * constraint is only imposed if the administrator has also requested
768     * {@link #PASSWORD_QUALITY_COMPLEX} with {@link #setPasswordQuality}. The
769     * default value is 0.
770     * <p>
771     * The calling device admin must have requested
772     * {@link DeviceAdminInfo#USES_POLICY_LIMIT_PASSWORD} to be able to call
773     * this method; if it has not, a security exception will be thrown.
774     *
775     * @param admin Which {@link DeviceAdminReceiver} this request is associated
776     *            with.
777     * @param length The new desired minimum number of upper case letters
778     *            required in the password. A value of 0 means there is no
779     *            restriction.
780     */
781    public void setPasswordMinimumUpperCase(ComponentName admin, int length) {
782        if (mService != null) {
783            try {
784                mService.setPasswordMinimumUpperCase(admin, length, UserHandle.myUserId());
785            } catch (RemoteException e) {
786                Log.w(TAG, "Failed talking with device policy service", e);
787            }
788        }
789    }
790
791    /**
792     * Retrieve the current number of upper case letters required in the
793     * password for all admins of this user and its profiles or a particular one.
794     * This is the same value as set by
795     * {#link {@link #setPasswordMinimumUpperCase(ComponentName, int)}
796     * and only applies when the password quality is
797     * {@link #PASSWORD_QUALITY_COMPLEX}.
798     *
799     * @param admin The name of the admin component to check, or null to
800     *            aggregate all admins.
801     * @return The minimum number of upper case letters required in the
802     *         password.
803     */
804    public int getPasswordMinimumUpperCase(ComponentName admin) {
805        return getPasswordMinimumUpperCase(admin, UserHandle.myUserId());
806    }
807
808    /** @hide per-user version */
809    public int getPasswordMinimumUpperCase(ComponentName admin, int userHandle) {
810        if (mService != null) {
811            try {
812                return mService.getPasswordMinimumUpperCase(admin, userHandle);
813            } catch (RemoteException e) {
814                Log.w(TAG, "Failed talking with device policy service", e);
815            }
816        }
817        return 0;
818    }
819
820    /**
821     * Called by an application that is administering the device to set the
822     * minimum number of lower case letters required in the password. After
823     * setting this, the user will not be able to enter a new password that is
824     * not at least as restrictive as what has been set. Note that the current
825     * password will remain until the user has set a new one, so the change does
826     * not take place immediately. To prompt the user for a new password, use
827     * {@link #ACTION_SET_NEW_PASSWORD} after setting this value. This
828     * constraint is only imposed if the administrator has also requested
829     * {@link #PASSWORD_QUALITY_COMPLEX} with {@link #setPasswordQuality}. The
830     * default value is 0.
831     * <p>
832     * The calling device admin must have requested
833     * {@link DeviceAdminInfo#USES_POLICY_LIMIT_PASSWORD} to be able to call
834     * this method; if it has not, a security exception will be thrown.
835     *
836     * @param admin Which {@link DeviceAdminReceiver} this request is associated
837     *            with.
838     * @param length The new desired minimum number of lower case letters
839     *            required in the password. A value of 0 means there is no
840     *            restriction.
841     */
842    public void setPasswordMinimumLowerCase(ComponentName admin, int length) {
843        if (mService != null) {
844            try {
845                mService.setPasswordMinimumLowerCase(admin, length, UserHandle.myUserId());
846            } catch (RemoteException e) {
847                Log.w(TAG, "Failed talking with device policy service", e);
848            }
849        }
850    }
851
852    /**
853     * Retrieve the current number of lower case letters required in the
854     * password for all admins of this user and its profiles or a particular one.
855     * This is the same value as set by
856     * {#link {@link #setPasswordMinimumLowerCase(ComponentName, int)}
857     * and only applies when the password quality is
858     * {@link #PASSWORD_QUALITY_COMPLEX}.
859     *
860     * @param admin The name of the admin component to check, or null to
861     *            aggregate all admins.
862     * @return The minimum number of lower case letters required in the
863     *         password.
864     */
865    public int getPasswordMinimumLowerCase(ComponentName admin) {
866        return getPasswordMinimumLowerCase(admin, UserHandle.myUserId());
867    }
868
869    /** @hide per-user version */
870    public int getPasswordMinimumLowerCase(ComponentName admin, int userHandle) {
871        if (mService != null) {
872            try {
873                return mService.getPasswordMinimumLowerCase(admin, userHandle);
874            } catch (RemoteException e) {
875                Log.w(TAG, "Failed talking with device policy service", e);
876            }
877        }
878        return 0;
879    }
880
881    /**
882     * Called by an application that is administering the device to set the
883     * minimum number of letters required in the password. After setting this,
884     * the user will not be able to enter a new password that is not at least as
885     * restrictive as what has been set. Note that the current password will
886     * remain until the user has set a new one, so the change does not take
887     * place immediately. To prompt the user for a new password, use
888     * {@link #ACTION_SET_NEW_PASSWORD} after setting this value. This
889     * constraint is only imposed if the administrator has also requested
890     * {@link #PASSWORD_QUALITY_COMPLEX} with {@link #setPasswordQuality}. The
891     * default value is 1.
892     * <p>
893     * The calling device admin must have requested
894     * {@link DeviceAdminInfo#USES_POLICY_LIMIT_PASSWORD} to be able to call
895     * this method; if it has not, a security exception will be thrown.
896     *
897     * @param admin Which {@link DeviceAdminReceiver} this request is associated
898     *            with.
899     * @param length The new desired minimum number of letters required in the
900     *            password. A value of 0 means there is no restriction.
901     */
902    public void setPasswordMinimumLetters(ComponentName admin, int length) {
903        if (mService != null) {
904            try {
905                mService.setPasswordMinimumLetters(admin, length, UserHandle.myUserId());
906            } catch (RemoteException e) {
907                Log.w(TAG, "Failed talking with device policy service", e);
908            }
909        }
910    }
911
912    /**
913     * Retrieve the current number of letters required in the password for all
914     * admins or a particular one. This is the same value as
915     * set by {#link {@link #setPasswordMinimumLetters(ComponentName, int)}
916     * and only applies when the password quality is
917     * {@link #PASSWORD_QUALITY_COMPLEX}.
918     *
919     * @param admin The name of the admin component to check, or null to
920     *            aggregate all admins.
921     * @return The minimum number of letters required in the password.
922     */
923    public int getPasswordMinimumLetters(ComponentName admin) {
924        return getPasswordMinimumLetters(admin, UserHandle.myUserId());
925    }
926
927    /** @hide per-user version */
928    public int getPasswordMinimumLetters(ComponentName admin, int userHandle) {
929        if (mService != null) {
930            try {
931                return mService.getPasswordMinimumLetters(admin, userHandle);
932            } catch (RemoteException e) {
933                Log.w(TAG, "Failed talking with device policy service", e);
934            }
935        }
936        return 0;
937    }
938
939    /**
940     * Called by an application that is administering the device to set the
941     * minimum number of numerical digits required in the password. After
942     * setting this, the user will not be able to enter a new password that is
943     * not at least as restrictive as what has been set. Note that the current
944     * password will remain until the user has set a new one, so the change does
945     * not take place immediately. To prompt the user for a new password, use
946     * {@link #ACTION_SET_NEW_PASSWORD} after setting this value. This
947     * constraint is only imposed if the administrator has also requested
948     * {@link #PASSWORD_QUALITY_COMPLEX} with {@link #setPasswordQuality}. The
949     * default value is 1.
950     * <p>
951     * The calling device admin must have requested
952     * {@link DeviceAdminInfo#USES_POLICY_LIMIT_PASSWORD} to be able to call
953     * this method; if it has not, a security exception will be thrown.
954     *
955     * @param admin Which {@link DeviceAdminReceiver} this request is associated
956     *            with.
957     * @param length The new desired minimum number of numerical digits required
958     *            in the password. A value of 0 means there is no restriction.
959     */
960    public void setPasswordMinimumNumeric(ComponentName admin, int length) {
961        if (mService != null) {
962            try {
963                mService.setPasswordMinimumNumeric(admin, length, UserHandle.myUserId());
964            } catch (RemoteException e) {
965                Log.w(TAG, "Failed talking with device policy service", e);
966            }
967        }
968    }
969
970    /**
971     * Retrieve the current number of numerical digits required in the password
972     * for all admins of this user and its profiles or a particular one.
973     * This is the same value as set by
974     * {#link {@link #setPasswordMinimumNumeric(ComponentName, int)}
975     * and only applies when the password quality is
976     * {@link #PASSWORD_QUALITY_COMPLEX}.
977     *
978     * @param admin The name of the admin component to check, or null to
979     *            aggregate all admins.
980     * @return The minimum number of numerical digits required in the password.
981     */
982    public int getPasswordMinimumNumeric(ComponentName admin) {
983        return getPasswordMinimumNumeric(admin, UserHandle.myUserId());
984    }
985
986    /** @hide per-user version */
987    public int getPasswordMinimumNumeric(ComponentName admin, int userHandle) {
988        if (mService != null) {
989            try {
990                return mService.getPasswordMinimumNumeric(admin, userHandle);
991            } catch (RemoteException e) {
992                Log.w(TAG, "Failed talking with device policy service", e);
993            }
994        }
995        return 0;
996    }
997
998    /**
999     * Called by an application that is administering the device to set the
1000     * minimum number of symbols required in the password. After setting this,
1001     * the user will not be able to enter a new password that is not at least as
1002     * restrictive as what has been set. Note that the current password will
1003     * remain until the user has set a new one, so the change does not take
1004     * place immediately. To prompt the user for a new password, use
1005     * {@link #ACTION_SET_NEW_PASSWORD} after setting this value. This
1006     * constraint is only imposed if the administrator has also requested
1007     * {@link #PASSWORD_QUALITY_COMPLEX} with {@link #setPasswordQuality}. The
1008     * default value is 1.
1009     * <p>
1010     * The calling device admin must have requested
1011     * {@link DeviceAdminInfo#USES_POLICY_LIMIT_PASSWORD} to be able to call
1012     * this method; if it has not, a security exception will be thrown.
1013     *
1014     * @param admin Which {@link DeviceAdminReceiver} this request is associated
1015     *            with.
1016     * @param length The new desired minimum number of symbols required in the
1017     *            password. A value of 0 means there is no restriction.
1018     */
1019    public void setPasswordMinimumSymbols(ComponentName admin, int length) {
1020        if (mService != null) {
1021            try {
1022                mService.setPasswordMinimumSymbols(admin, length, UserHandle.myUserId());
1023            } catch (RemoteException e) {
1024                Log.w(TAG, "Failed talking with device policy service", e);
1025            }
1026        }
1027    }
1028
1029    /**
1030     * Retrieve the current number of symbols required in the password for all
1031     * admins or a particular one. This is the same value as
1032     * set by {#link {@link #setPasswordMinimumSymbols(ComponentName, int)}
1033     * and only applies when the password quality is
1034     * {@link #PASSWORD_QUALITY_COMPLEX}.
1035     *
1036     * @param admin The name of the admin component to check, or null to
1037     *            aggregate all admins.
1038     * @return The minimum number of symbols required in the password.
1039     */
1040    public int getPasswordMinimumSymbols(ComponentName admin) {
1041        return getPasswordMinimumSymbols(admin, UserHandle.myUserId());
1042    }
1043
1044    /** @hide per-user version */
1045    public int getPasswordMinimumSymbols(ComponentName admin, int userHandle) {
1046        if (mService != null) {
1047            try {
1048                return mService.getPasswordMinimumSymbols(admin, userHandle);
1049            } catch (RemoteException e) {
1050                Log.w(TAG, "Failed talking with device policy service", e);
1051            }
1052        }
1053        return 0;
1054    }
1055
1056    /**
1057     * Called by an application that is administering the device to set the
1058     * minimum number of non-letter characters (numerical digits or symbols)
1059     * required in the password. After setting this, the user will not be able
1060     * to enter a new password that is not at least as restrictive as what has
1061     * been set. Note that the current password will remain until the user has
1062     * set a new one, so the change does not take place immediately. To prompt
1063     * the user for a new password, use {@link #ACTION_SET_NEW_PASSWORD} after
1064     * setting this value. This constraint is only imposed if the administrator
1065     * has also requested {@link #PASSWORD_QUALITY_COMPLEX} with
1066     * {@link #setPasswordQuality}. The default value is 0.
1067     * <p>
1068     * The calling device admin must have requested
1069     * {@link DeviceAdminInfo#USES_POLICY_LIMIT_PASSWORD} to be able to call
1070     * this method; if it has not, a security exception will be thrown.
1071     *
1072     * @param admin Which {@link DeviceAdminReceiver} this request is associated
1073     *            with.
1074     * @param length The new desired minimum number of letters required in the
1075     *            password. A value of 0 means there is no restriction.
1076     */
1077    public void setPasswordMinimumNonLetter(ComponentName admin, int length) {
1078        if (mService != null) {
1079            try {
1080                mService.setPasswordMinimumNonLetter(admin, length, UserHandle.myUserId());
1081            } catch (RemoteException e) {
1082                Log.w(TAG, "Failed talking with device policy service", e);
1083            }
1084        }
1085    }
1086
1087    /**
1088     * Retrieve the current number of non-letter characters required in the
1089     * password for all admins of this user and its profiles or a particular one.
1090     * This is the same value as set by
1091     * {#link {@link #setPasswordMinimumNonLetter(ComponentName, int)}
1092     * and only applies when the password quality is
1093     * {@link #PASSWORD_QUALITY_COMPLEX}.
1094     *
1095     * @param admin The name of the admin component to check, or null to
1096     *            aggregate all admins.
1097     * @return The minimum number of letters required in the password.
1098     */
1099    public int getPasswordMinimumNonLetter(ComponentName admin) {
1100        return getPasswordMinimumNonLetter(admin, UserHandle.myUserId());
1101    }
1102
1103    /** @hide per-user version */
1104    public int getPasswordMinimumNonLetter(ComponentName admin, int userHandle) {
1105        if (mService != null) {
1106            try {
1107                return mService.getPasswordMinimumNonLetter(admin, userHandle);
1108            } catch (RemoteException e) {
1109                Log.w(TAG, "Failed talking with device policy service", e);
1110            }
1111        }
1112        return 0;
1113    }
1114
1115  /**
1116   * Called by an application that is administering the device to set the length
1117   * of the password history. After setting this, the user will not be able to
1118   * enter a new password that is the same as any password in the history. Note
1119   * that the current password will remain until the user has set a new one, so
1120   * the change does not take place immediately. To prompt the user for a new
1121   * password, use {@link #ACTION_SET_NEW_PASSWORD} after setting this value.
1122   * This constraint is only imposed if the administrator has also requested
1123   * either {@link #PASSWORD_QUALITY_NUMERIC}, {@link #PASSWORD_QUALITY_NUMERIC_COMPLEX}
1124   * {@link #PASSWORD_QUALITY_ALPHABETIC}, or {@link #PASSWORD_QUALITY_ALPHANUMERIC}
1125   * with {@link #setPasswordQuality}.
1126   *
1127   * <p>
1128   * The calling device admin must have requested
1129   * {@link DeviceAdminInfo#USES_POLICY_LIMIT_PASSWORD} to be able to call this
1130   * method; if it has not, a security exception will be thrown.
1131   *
1132   * @param admin Which {@link DeviceAdminReceiver} this request is associated
1133   *        with.
1134   * @param length The new desired length of password history. A value of 0
1135   *        means there is no restriction.
1136   */
1137    public void setPasswordHistoryLength(ComponentName admin, int length) {
1138        if (mService != null) {
1139            try {
1140                mService.setPasswordHistoryLength(admin, length, UserHandle.myUserId());
1141            } catch (RemoteException e) {
1142                Log.w(TAG, "Failed talking with device policy service", e);
1143            }
1144        }
1145    }
1146
1147    /**
1148     * Called by a device admin to set the password expiration timeout. Calling this method
1149     * will restart the countdown for password expiration for the given admin, as will changing
1150     * the device password (for all admins).
1151     *
1152     * <p>The provided timeout is the time delta in ms and will be added to the current time.
1153     * For example, to have the password expire 5 days from now, timeout would be
1154     * 5 * 86400 * 1000 = 432000000 ms for timeout.
1155     *
1156     * <p>To disable password expiration, a value of 0 may be used for timeout.
1157     *
1158     * <p>The calling device admin must have requested
1159     * {@link DeviceAdminInfo#USES_POLICY_EXPIRE_PASSWORD} to be able to call this
1160     * method; if it has not, a security exception will be thrown.
1161     *
1162     * <p> Note that setting the password will automatically reset the expiration time for all
1163     * active admins. Active admins do not need to explicitly call this method in that case.
1164     *
1165     * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
1166     * @param timeout The limit (in ms) that a password can remain in effect. A value of 0
1167     *        means there is no restriction (unlimited).
1168     */
1169    public void setPasswordExpirationTimeout(ComponentName admin, long timeout) {
1170        if (mService != null) {
1171            try {
1172                mService.setPasswordExpirationTimeout(admin, timeout, UserHandle.myUserId());
1173            } catch (RemoteException e) {
1174                Log.w(TAG, "Failed talking with device policy service", e);
1175            }
1176        }
1177    }
1178
1179    /**
1180     * Get the password expiration timeout for the given admin. The expiration timeout is the
1181     * recurring expiration timeout provided in the call to
1182     * {@link #setPasswordExpirationTimeout(ComponentName, long)} for the given admin or the
1183     * aggregate of all policy administrators if admin is null.
1184     *
1185     * @param admin The name of the admin component to check, or null to aggregate all admins.
1186     * @return The timeout for the given admin or the minimum of all timeouts
1187     */
1188    public long getPasswordExpirationTimeout(ComponentName admin) {
1189        if (mService != null) {
1190            try {
1191                return mService.getPasswordExpirationTimeout(admin, UserHandle.myUserId());
1192            } catch (RemoteException e) {
1193                Log.w(TAG, "Failed talking with device policy service", e);
1194            }
1195        }
1196        return 0;
1197    }
1198
1199    /**
1200     * Get the current password expiration time for the given admin or an aggregate of
1201     * all admins of this user and its profiles if admin is null. If the password is
1202     * expired, this will return the time since the password expired as a negative number.
1203     * If admin is null, then a composite of all expiration timeouts is returned
1204     * - which will be the minimum of all timeouts.
1205     *
1206     * @param admin The name of the admin component to check, or null to aggregate all admins.
1207     * @return The password expiration time, in ms.
1208     */
1209    public long getPasswordExpiration(ComponentName admin) {
1210        if (mService != null) {
1211            try {
1212                return mService.getPasswordExpiration(admin, UserHandle.myUserId());
1213            } catch (RemoteException e) {
1214                Log.w(TAG, "Failed talking with device policy service", e);
1215            }
1216        }
1217        return 0;
1218    }
1219
1220    /**
1221     * Retrieve the current password history length for all admins of this
1222     * user and its profiles or a particular one.
1223     * @param admin The name of the admin component to check, or null to aggregate
1224     * all admins.
1225     * @return The length of the password history
1226     */
1227    public int getPasswordHistoryLength(ComponentName admin) {
1228        return getPasswordHistoryLength(admin, UserHandle.myUserId());
1229    }
1230
1231    /** @hide per-user version */
1232    public int getPasswordHistoryLength(ComponentName admin, int userHandle) {
1233        if (mService != null) {
1234            try {
1235                return mService.getPasswordHistoryLength(admin, userHandle);
1236            } catch (RemoteException e) {
1237                Log.w(TAG, "Failed talking with device policy service", e);
1238            }
1239        }
1240        return 0;
1241    }
1242
1243    /**
1244     * Return the maximum password length that the device supports for a
1245     * particular password quality.
1246     * @param quality The quality being interrogated.
1247     * @return Returns the maximum length that the user can enter.
1248     */
1249    public int getPasswordMaximumLength(int quality) {
1250        // Kind-of arbitrary.
1251        return 16;
1252    }
1253
1254    /**
1255     * Determine whether the current password the user has set is sufficient
1256     * to meet the policy requirements (quality, minimum length) that have been
1257     * requested by the admins of this user and its profiles.
1258     *
1259     * <p>The calling device admin must have requested
1260     * {@link DeviceAdminInfo#USES_POLICY_LIMIT_PASSWORD} to be able to call
1261     * this method; if it has not, a security exception will be thrown.
1262     *
1263     * @return Returns true if the password meets the current requirements, else false.
1264     */
1265    public boolean isActivePasswordSufficient() {
1266        if (mService != null) {
1267            try {
1268                return mService.isActivePasswordSufficient(UserHandle.myUserId());
1269            } catch (RemoteException e) {
1270                Log.w(TAG, "Failed talking with device policy service", e);
1271            }
1272        }
1273        return false;
1274    }
1275
1276    /**
1277     * Retrieve the number of times the user has failed at entering a
1278     * password since that last successful password entry.
1279     *
1280     * <p>The calling device admin must have requested
1281     * {@link DeviceAdminInfo#USES_POLICY_WATCH_LOGIN} to be able to call
1282     * this method; if it has not, a security exception will be thrown.
1283     */
1284    public int getCurrentFailedPasswordAttempts() {
1285        if (mService != null) {
1286            try {
1287                return mService.getCurrentFailedPasswordAttempts(UserHandle.myUserId());
1288            } catch (RemoteException e) {
1289                Log.w(TAG, "Failed talking with device policy service", e);
1290            }
1291        }
1292        return -1;
1293    }
1294
1295    /**
1296     * Setting this to a value greater than zero enables a built-in policy
1297     * that will perform a device wipe after too many incorrect
1298     * device-unlock passwords have been entered.  This built-in policy combines
1299     * watching for failed passwords and wiping the device, and requires
1300     * that you request both {@link DeviceAdminInfo#USES_POLICY_WATCH_LOGIN} and
1301     * {@link DeviceAdminInfo#USES_POLICY_WIPE_DATA}}.
1302     *
1303     * <p>To implement any other policy (e.g. wiping data for a particular
1304     * application only, erasing or revoking credentials, or reporting the
1305     * failure to a server), you should implement
1306     * {@link DeviceAdminReceiver#onPasswordFailed(Context, android.content.Intent)}
1307     * instead.  Do not use this API, because if the maximum count is reached,
1308     * the device will be wiped immediately, and your callback will not be invoked.
1309     *
1310     * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
1311     * @param num The number of failed password attempts at which point the
1312     * device will wipe its data.
1313     */
1314    public void setMaximumFailedPasswordsForWipe(ComponentName admin, int num) {
1315        if (mService != null) {
1316            try {
1317                mService.setMaximumFailedPasswordsForWipe(admin, num, UserHandle.myUserId());
1318            } catch (RemoteException e) {
1319                Log.w(TAG, "Failed talking with device policy service", e);
1320            }
1321        }
1322    }
1323
1324    /**
1325     * Retrieve the current maximum number of login attempts that are allowed
1326     * before the device wipes itself, for all admins of this user and its profiles
1327     * or a particular one.
1328     * @param admin The name of the admin component to check, or null to aggregate
1329     * all admins.
1330     */
1331    public int getMaximumFailedPasswordsForWipe(ComponentName admin) {
1332        return getMaximumFailedPasswordsForWipe(admin, UserHandle.myUserId());
1333    }
1334
1335    /** @hide per-user version */
1336    public int getMaximumFailedPasswordsForWipe(ComponentName admin, int userHandle) {
1337        if (mService != null) {
1338            try {
1339                return mService.getMaximumFailedPasswordsForWipe(admin, userHandle);
1340            } catch (RemoteException e) {
1341                Log.w(TAG, "Failed talking with device policy service", e);
1342            }
1343        }
1344        return 0;
1345    }
1346
1347    /**
1348     * Flag for {@link #resetPassword}: don't allow other admins to change
1349     * the password again until the user has entered it.
1350     */
1351    public static final int RESET_PASSWORD_REQUIRE_ENTRY = 0x0001;
1352
1353    /**
1354     * Force a new device unlock password (the password needed to access the
1355     * entire device, not for individual accounts) on the user.  This takes
1356     * effect immediately.
1357     * The given password must be sufficient for the
1358     * current password quality and length constraints as returned by
1359     * {@link #getPasswordQuality(ComponentName)} and
1360     * {@link #getPasswordMinimumLength(ComponentName)}; if it does not meet
1361     * these constraints, then it will be rejected and false returned.  Note
1362     * that the password may be a stronger quality (containing alphanumeric
1363     * characters when the requested quality is only numeric), in which case
1364     * the currently active quality will be increased to match.
1365     *
1366     * <p>Calling with a null or empty password will clear any existing PIN,
1367     * pattern or password if the current password constraints allow it.
1368     *
1369     * <p>The calling device admin must have requested
1370     * {@link DeviceAdminInfo#USES_POLICY_RESET_PASSWORD} to be able to call
1371     * this method; if it has not, a security exception will be thrown.
1372     *
1373     * <p>Calling this from a managed profile will throw a security exception.
1374     *
1375     * @param password The new password for the user. Null or empty clears the password.
1376     * @param flags May be 0 or {@link #RESET_PASSWORD_REQUIRE_ENTRY}.
1377     * @return Returns true if the password was applied, or false if it is
1378     * not acceptable for the current constraints.
1379     */
1380    public boolean resetPassword(String password, int flags) {
1381        if (mService != null) {
1382            try {
1383                return mService.resetPassword(password, flags, UserHandle.myUserId());
1384            } catch (RemoteException e) {
1385                Log.w(TAG, "Failed talking with device policy service", e);
1386            }
1387        }
1388        return false;
1389    }
1390
1391    /**
1392     * Called by an application that is administering the device to set the
1393     * maximum time for user activity until the device will lock.  This limits
1394     * the length that the user can set.  It takes effect immediately.
1395     *
1396     * <p>The calling device admin must have requested
1397     * {@link DeviceAdminInfo#USES_POLICY_FORCE_LOCK} to be able to call
1398     * this method; if it has not, a security exception will be thrown.
1399     *
1400     * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
1401     * @param timeMs The new desired maximum time to lock in milliseconds.
1402     * A value of 0 means there is no restriction.
1403     */
1404    public void setMaximumTimeToLock(ComponentName admin, long timeMs) {
1405        if (mService != null) {
1406            try {
1407                mService.setMaximumTimeToLock(admin, timeMs, UserHandle.myUserId());
1408            } catch (RemoteException e) {
1409                Log.w(TAG, "Failed talking with device policy service", e);
1410            }
1411        }
1412    }
1413
1414    /**
1415     * Retrieve the current maximum time to unlock for all admins of this user
1416     * and its profiles or a particular one.
1417     * @param admin The name of the admin component to check, or null to aggregate
1418     * all admins.
1419     * @return time in milliseconds for the given admin or the minimum value (strictest) of
1420     * all admins if admin is null. Returns 0 if there are no restrictions.
1421     */
1422    public long getMaximumTimeToLock(ComponentName admin) {
1423        return getMaximumTimeToLock(admin, UserHandle.myUserId());
1424    }
1425
1426    /** @hide per-user version */
1427    public long getMaximumTimeToLock(ComponentName admin, int userHandle) {
1428        if (mService != null) {
1429            try {
1430                return mService.getMaximumTimeToLock(admin, userHandle);
1431            } catch (RemoteException e) {
1432                Log.w(TAG, "Failed talking with device policy service", e);
1433            }
1434        }
1435        return 0;
1436    }
1437
1438    /**
1439     * Make the device lock immediately, as if the lock screen timeout has
1440     * expired at the point of this call.
1441     *
1442     * <p>The calling device admin must have requested
1443     * {@link DeviceAdminInfo#USES_POLICY_FORCE_LOCK} to be able to call
1444     * this method; if it has not, a security exception will be thrown.
1445     */
1446    public void lockNow() {
1447        if (mService != null) {
1448            try {
1449                mService.lockNow();
1450            } catch (RemoteException e) {
1451                Log.w(TAG, "Failed talking with device policy service", e);
1452            }
1453        }
1454    }
1455
1456    /**
1457     * Flag for {@link #wipeData(int)}: also erase the device's external
1458     * storage.
1459     */
1460    public static final int WIPE_EXTERNAL_STORAGE = 0x0001;
1461
1462    /**
1463     * Ask the user data be wiped.  This will cause the device to reboot,
1464     * erasing all user data while next booting up.  External storage such
1465     * as SD cards will be also erased if the flag {@link #WIPE_EXTERNAL_STORAGE}
1466     * is set.
1467     *
1468     * <p>The calling device admin must have requested
1469     * {@link DeviceAdminInfo#USES_POLICY_WIPE_DATA} to be able to call
1470     * this method; if it has not, a security exception will be thrown.
1471     *
1472     * @param flags Bit mask of additional options: currently 0 and
1473     *              {@link #WIPE_EXTERNAL_STORAGE} are supported.
1474     */
1475    public void wipeData(int flags) {
1476        if (mService != null) {
1477            try {
1478                mService.wipeData(flags, UserHandle.myUserId());
1479            } catch (RemoteException e) {
1480                Log.w(TAG, "Failed talking with device policy service", e);
1481            }
1482        }
1483    }
1484
1485    /**
1486     * Called by an application that is administering the device to set the
1487     * global proxy and exclusion list.
1488     * <p>
1489     * The calling device admin must have requested
1490     * {@link DeviceAdminInfo#USES_POLICY_SETS_GLOBAL_PROXY} to be able to call
1491     * this method; if it has not, a security exception will be thrown.
1492     * Only the first device admin can set the proxy. If a second admin attempts
1493     * to set the proxy, the {@link ComponentName} of the admin originally setting the
1494     * proxy will be returned. If successful in setting the proxy, null will
1495     * be returned.
1496     * The method can be called repeatedly by the device admin alrady setting the
1497     * proxy to update the proxy and exclusion list.
1498     *
1499     * @param admin Which {@link DeviceAdminReceiver} this request is associated
1500     *            with.
1501     * @param proxySpec the global proxy desired. Must be an HTTP Proxy.
1502     *            Pass Proxy.NO_PROXY to reset the proxy.
1503     * @param exclusionList a list of domains to be excluded from the global proxy.
1504     * @return returns null if the proxy was successfully set, or a {@link ComponentName}
1505     *            of the device admin that sets thew proxy otherwise.
1506     * @hide
1507     */
1508    public ComponentName setGlobalProxy(ComponentName admin, Proxy proxySpec,
1509            List<String> exclusionList ) {
1510        if (proxySpec == null) {
1511            throw new NullPointerException();
1512        }
1513        if (mService != null) {
1514            try {
1515                String hostSpec;
1516                String exclSpec;
1517                if (proxySpec.equals(Proxy.NO_PROXY)) {
1518                    hostSpec = null;
1519                    exclSpec = null;
1520                } else {
1521                    if (!proxySpec.type().equals(Proxy.Type.HTTP)) {
1522                        throw new IllegalArgumentException();
1523                    }
1524                    InetSocketAddress sa = (InetSocketAddress)proxySpec.address();
1525                    String hostName = sa.getHostName();
1526                    int port = sa.getPort();
1527                    StringBuilder hostBuilder = new StringBuilder();
1528                    hostSpec = hostBuilder.append(hostName)
1529                        .append(":").append(Integer.toString(port)).toString();
1530                    if (exclusionList == null) {
1531                        exclSpec = "";
1532                    } else {
1533                        StringBuilder listBuilder = new StringBuilder();
1534                        boolean firstDomain = true;
1535                        for (String exclDomain : exclusionList) {
1536                            if (!firstDomain) {
1537                                listBuilder = listBuilder.append(",");
1538                            } else {
1539                                firstDomain = false;
1540                            }
1541                            listBuilder = listBuilder.append(exclDomain.trim());
1542                        }
1543                        exclSpec = listBuilder.toString();
1544                    }
1545                    if (android.net.Proxy.validate(hostName, Integer.toString(port), exclSpec)
1546                            != android.net.Proxy.PROXY_VALID)
1547                        throw new IllegalArgumentException();
1548                }
1549                return mService.setGlobalProxy(admin, hostSpec, exclSpec, UserHandle.myUserId());
1550            } catch (RemoteException e) {
1551                Log.w(TAG, "Failed talking with device policy service", e);
1552            }
1553        }
1554        return null;
1555    }
1556
1557    /**
1558     * Set a network-independent global HTTP proxy.  This is not normally what you want
1559     * for typical HTTP proxies - they are generally network dependent.  However if you're
1560     * doing something unusual like general internal filtering this may be useful.  On
1561     * a private network where the proxy is not accessible, you may break HTTP using this.
1562     *
1563     * <p>This method requires the caller to be the device owner.
1564     *
1565     * <p>This proxy is only a recommendation and it is possible that some apps will ignore it.
1566     * @see ProxyInfo
1567     *
1568     * @param admin Which {@link DeviceAdminReceiver} this request is associated
1569     *            with.
1570     * @param proxyInfo The a {@link ProxyInfo} object defining the new global
1571     *        HTTP proxy.  A {@code null} value will clear the global HTTP proxy.
1572     */
1573    public void setRecommendedGlobalProxy(ComponentName admin, ProxyInfo proxyInfo) {
1574        if (mService != null) {
1575            try {
1576                mService.setRecommendedGlobalProxy(admin, proxyInfo);
1577            } catch (RemoteException e) {
1578                Log.w(TAG, "Failed talking with device policy service", e);
1579            }
1580        }
1581    }
1582
1583    /**
1584     * Returns the component name setting the global proxy.
1585     * @return ComponentName object of the device admin that set the global proxy, or
1586     *            null if no admin has set the proxy.
1587     * @hide
1588     */
1589    public ComponentName getGlobalProxyAdmin() {
1590        if (mService != null) {
1591            try {
1592                return mService.getGlobalProxyAdmin(UserHandle.myUserId());
1593            } catch (RemoteException e) {
1594                Log.w(TAG, "Failed talking with device policy service", e);
1595            }
1596        }
1597        return null;
1598    }
1599
1600    /**
1601     * Result code for {@link #setStorageEncryption} and {@link #getStorageEncryptionStatus}:
1602     * indicating that encryption is not supported.
1603     */
1604    public static final int ENCRYPTION_STATUS_UNSUPPORTED = 0;
1605
1606    /**
1607     * Result code for {@link #setStorageEncryption} and {@link #getStorageEncryptionStatus}:
1608     * indicating that encryption is supported, but is not currently active.
1609     */
1610    public static final int ENCRYPTION_STATUS_INACTIVE = 1;
1611
1612    /**
1613     * Result code for {@link #setStorageEncryption} and {@link #getStorageEncryptionStatus}:
1614     * indicating that encryption is not currently active, but is currently
1615     * being activated.  This is only reported by devices that support
1616     * encryption of data and only when the storage is currently
1617     * undergoing a process of becoming encrypted.  A device that must reboot and/or wipe data
1618     * to become encrypted will never return this value.
1619     */
1620    public static final int ENCRYPTION_STATUS_ACTIVATING = 2;
1621
1622    /**
1623     * Result code for {@link #setStorageEncryption} and {@link #getStorageEncryptionStatus}:
1624     * indicating that encryption is active.
1625     */
1626    public static final int ENCRYPTION_STATUS_ACTIVE = 3;
1627
1628    /**
1629     * Activity action: begin the process of encrypting data on the device.  This activity should
1630     * be launched after using {@link #setStorageEncryption} to request encryption be activated.
1631     * After resuming from this activity, use {@link #getStorageEncryption}
1632     * to check encryption status.  However, on some devices this activity may never return, as
1633     * it may trigger a reboot and in some cases a complete data wipe of the device.
1634     */
1635    @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1636    public static final String ACTION_START_ENCRYPTION
1637            = "android.app.action.START_ENCRYPTION";
1638
1639    /**
1640     * Widgets are enabled in keyguard
1641     */
1642    public static final int KEYGUARD_DISABLE_FEATURES_NONE = 0;
1643
1644    /**
1645     * Disable all keyguard widgets. Has no effect.
1646     */
1647    public static final int KEYGUARD_DISABLE_WIDGETS_ALL = 1 << 0;
1648
1649    /**
1650     * Disable the camera on secure keyguard screens (e.g. PIN/Pattern/Password)
1651     */
1652    public static final int KEYGUARD_DISABLE_SECURE_CAMERA = 1 << 1;
1653
1654    /**
1655     * Disable showing all notifications on secure keyguard screens (e.g. PIN/Pattern/Password)
1656     */
1657    public static final int KEYGUARD_DISABLE_SECURE_NOTIFICATIONS = 1 << 2;
1658
1659    /**
1660     * Only allow redacted notifications on secure keyguard screens (e.g. PIN/Pattern/Password)
1661     */
1662    public static final int KEYGUARD_DISABLE_UNREDACTED_NOTIFICATIONS = 1 << 3;
1663
1664    /**
1665     * Ignore trust agent state on secure keyguard screens
1666     * (e.g. PIN/Pattern/Password).
1667     */
1668    public static final int KEYGUARD_DISABLE_TRUST_AGENTS = 1 << 4;
1669
1670    /**
1671     * Disable fingerprint sensor on keyguard secure screens (e.g. PIN/Pattern/Password).
1672     */
1673    public static final int KEYGUARD_DISABLE_FINGERPRINT = 1 << 5;
1674
1675    /**
1676     * Disable all current and future keyguard customizations.
1677     */
1678    public static final int KEYGUARD_DISABLE_FEATURES_ALL = 0x7fffffff;
1679
1680    /**
1681     * Called by an application that is administering the device to
1682     * request that the storage system be encrypted.
1683     *
1684     * <p>When multiple device administrators attempt to control device
1685     * encryption, the most secure, supported setting will always be
1686     * used.  If any device administrator requests device encryption,
1687     * it will be enabled;  Conversely, if a device administrator
1688     * attempts to disable device encryption while another
1689     * device administrator has enabled it, the call to disable will
1690     * fail (most commonly returning {@link #ENCRYPTION_STATUS_ACTIVE}).
1691     *
1692     * <p>This policy controls encryption of the secure (application data) storage area.  Data
1693     * written to other storage areas may or may not be encrypted, and this policy does not require
1694     * or control the encryption of any other storage areas.
1695     * There is one exception:  If {@link android.os.Environment#isExternalStorageEmulated()} is
1696     * {@code true}, then the directory returned by
1697     * {@link android.os.Environment#getExternalStorageDirectory()} must be written to disk
1698     * within the encrypted storage area.
1699     *
1700     * <p>Important Note:  On some devices, it is possible to encrypt storage without requiring
1701     * the user to create a device PIN or Password.  In this case, the storage is encrypted, but
1702     * the encryption key may not be fully secured.  For maximum security, the administrator should
1703     * also require (and check for) a pattern, PIN, or password.
1704     *
1705     * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
1706     * @param encrypt true to request encryption, false to release any previous request
1707     * @return the new request status (for all active admins) - will be one of
1708     * {@link #ENCRYPTION_STATUS_UNSUPPORTED}, {@link #ENCRYPTION_STATUS_INACTIVE}, or
1709     * {@link #ENCRYPTION_STATUS_ACTIVE}.  This is the value of the requests;  Use
1710     * {@link #getStorageEncryptionStatus()} to query the actual device state.
1711     */
1712    public int setStorageEncryption(ComponentName admin, boolean encrypt) {
1713        if (mService != null) {
1714            try {
1715                return mService.setStorageEncryption(admin, encrypt, UserHandle.myUserId());
1716            } catch (RemoteException e) {
1717                Log.w(TAG, "Failed talking with device policy service", e);
1718            }
1719        }
1720        return ENCRYPTION_STATUS_UNSUPPORTED;
1721    }
1722
1723    /**
1724     * Called by an application that is administering the device to
1725     * determine the requested setting for secure storage.
1726     *
1727     * @param admin Which {@link DeviceAdminReceiver} this request is associated with.  If null,
1728     * this will return the requested encryption setting as an aggregate of all active
1729     * administrators.
1730     * @return true if the admin(s) are requesting encryption, false if not.
1731     */
1732    public boolean getStorageEncryption(ComponentName admin) {
1733        if (mService != null) {
1734            try {
1735                return mService.getStorageEncryption(admin, UserHandle.myUserId());
1736            } catch (RemoteException e) {
1737                Log.w(TAG, "Failed talking with device policy service", e);
1738            }
1739        }
1740        return false;
1741    }
1742
1743    /**
1744     * Called by an application that is administering the device to
1745     * determine the current encryption status of the device.
1746     *
1747     * Depending on the returned status code, the caller may proceed in different
1748     * ways.  If the result is {@link #ENCRYPTION_STATUS_UNSUPPORTED}, the
1749     * storage system does not support encryption.  If the
1750     * result is {@link #ENCRYPTION_STATUS_INACTIVE}, use {@link
1751     * #ACTION_START_ENCRYPTION} to begin the process of encrypting or decrypting the
1752     * storage.  If the result is {@link #ENCRYPTION_STATUS_ACTIVATING} or
1753     * {@link #ENCRYPTION_STATUS_ACTIVE}, no further action is required.
1754     *
1755     * @return current status of encryption. The value will be one of
1756     * {@link #ENCRYPTION_STATUS_UNSUPPORTED}, {@link #ENCRYPTION_STATUS_INACTIVE},
1757     * {@link #ENCRYPTION_STATUS_ACTIVATING}, or{@link #ENCRYPTION_STATUS_ACTIVE}.
1758     */
1759    public int getStorageEncryptionStatus() {
1760        return getStorageEncryptionStatus(UserHandle.myUserId());
1761    }
1762
1763    /** @hide per-user version */
1764    public int getStorageEncryptionStatus(int userHandle) {
1765        if (mService != null) {
1766            try {
1767                return mService.getStorageEncryptionStatus(userHandle);
1768            } catch (RemoteException e) {
1769                Log.w(TAG, "Failed talking with device policy service", e);
1770            }
1771        }
1772        return ENCRYPTION_STATUS_UNSUPPORTED;
1773    }
1774
1775    /**
1776     * Installs the given certificate as a user CA.
1777     *
1778     * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
1779     * @param certBuffer encoded form of the certificate to install.
1780     *
1781     * @return false if the certBuffer cannot be parsed or installation is
1782     *         interrupted, true otherwise.
1783     */
1784    public boolean installCaCert(ComponentName admin, byte[] certBuffer) {
1785        if (mService != null) {
1786            try {
1787                return mService.installCaCert(admin, certBuffer);
1788            } catch (RemoteException e) {
1789                Log.w(TAG, "Failed talking with device policy service", e);
1790            }
1791        }
1792        return false;
1793    }
1794
1795    /**
1796     * Uninstalls the given certificate from trusted user CAs, if present.
1797     *
1798     * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
1799     * @param certBuffer encoded form of the certificate to remove.
1800     */
1801    public void uninstallCaCert(ComponentName admin, byte[] certBuffer) {
1802        if (mService != null) {
1803            try {
1804                final String alias = getCaCertAlias(certBuffer);
1805                mService.uninstallCaCert(admin, alias);
1806            } catch (CertificateException e) {
1807                Log.w(TAG, "Unable to parse certificate", e);
1808            } catch (RemoteException e) {
1809                Log.w(TAG, "Failed talking with device policy service", e);
1810            }
1811        }
1812    }
1813
1814    /**
1815     * Returns all CA certificates that are currently trusted, excluding system CA certificates.
1816     * If a user has installed any certificates by other means than device policy these will be
1817     * included too.
1818     *
1819     * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
1820     * @return a List of byte[] arrays, each encoding one user CA certificate.
1821     */
1822    public List<byte[]> getInstalledCaCerts(ComponentName admin) {
1823        List<byte[]> certs = new ArrayList<byte[]>();
1824        if (mService != null) {
1825            try {
1826                mService.enforceCanManageCaCerts(admin);
1827                final TrustedCertificateStore certStore = new TrustedCertificateStore();
1828                for (String alias : certStore.userAliases()) {
1829                    try {
1830                        certs.add(certStore.getCertificate(alias).getEncoded());
1831                    } catch (CertificateException ce) {
1832                        Log.w(TAG, "Could not encode certificate: " + alias, ce);
1833                    }
1834                }
1835            } catch (RemoteException re) {
1836                Log.w(TAG, "Failed talking with device policy service", re);
1837            }
1838        }
1839        return certs;
1840    }
1841
1842    /**
1843     * Uninstalls all custom trusted CA certificates from the profile. Certificates installed by
1844     * means other than device policy will also be removed, except for system CA certificates.
1845     *
1846     * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
1847     */
1848    public void uninstallAllUserCaCerts(ComponentName admin) {
1849        if (mService != null) {
1850            for (String alias : new TrustedCertificateStore().userAliases()) {
1851                try {
1852                    mService.uninstallCaCert(admin, alias);
1853                } catch (RemoteException re) {
1854                    Log.w(TAG, "Failed talking with device policy service", re);
1855                }
1856            }
1857        }
1858    }
1859
1860    /**
1861     * Returns whether this certificate is installed as a trusted CA.
1862     *
1863     * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
1864     * @param certBuffer encoded form of the certificate to look up.
1865     */
1866    public boolean hasCaCertInstalled(ComponentName admin, byte[] certBuffer) {
1867        if (mService != null) {
1868            try {
1869                mService.enforceCanManageCaCerts(admin);
1870                return getCaCertAlias(certBuffer) != null;
1871            } catch (RemoteException re) {
1872                Log.w(TAG, "Failed talking with device policy service", re);
1873            } catch (CertificateException ce) {
1874                Log.w(TAG, "Could not parse certificate", ce);
1875            }
1876        }
1877        return false;
1878    }
1879
1880    /**
1881     * Called by a device or profile owner to install a certificate and private key pair. The
1882     * keypair will be visible to all apps within the profile.
1883     *
1884     * @param who Which {@link DeviceAdminReceiver} this request is associated with.
1885     * @param privKey The private key to install.
1886     * @param cert The certificate to install.
1887     * @param alias The private key alias under which to install the certificate. If a certificate
1888     * with that alias already exists, it will be overwritten.
1889     * @return {@code true} if the keys were installed, {@code false} otherwise.
1890     */
1891    public boolean installKeyPair(ComponentName who, PrivateKey privKey, Certificate cert,
1892            String alias) {
1893        try {
1894            final byte[] pemCert = Credentials.convertToPem(cert);
1895            return mService.installKeyPair(who, privKey.getEncoded(), pemCert, alias);
1896        } catch (CertificateException e) {
1897            Log.w(TAG, "Error encoding certificate", e);
1898        } catch (IOException e) {
1899            Log.w(TAG, "Error writing certificate", e);
1900        } catch (RemoteException e) {
1901            Log.w(TAG, "Failed talking with device policy service", e);
1902        }
1903        return false;
1904    }
1905
1906    /**
1907     * Returns the alias of a given CA certificate in the certificate store, or null if it
1908     * doesn't exist.
1909     */
1910    private static String getCaCertAlias(byte[] certBuffer) throws CertificateException {
1911        final CertificateFactory certFactory = CertificateFactory.getInstance("X.509");
1912        final X509Certificate cert = (X509Certificate) certFactory.generateCertificate(
1913                              new ByteArrayInputStream(certBuffer));
1914        return new TrustedCertificateStore().getCertificateAlias(cert);
1915    }
1916
1917    /**
1918     * Called by an application that is administering the device to disable all cameras
1919     * on the device, for this user. After setting this, no applications running as this user
1920     * will be able to access any cameras on the device.
1921     *
1922     * <p>The calling device admin must have requested
1923     * {@link DeviceAdminInfo#USES_POLICY_DISABLE_CAMERA} to be able to call
1924     * this method; if it has not, a security exception will be thrown.
1925     *
1926     * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
1927     * @param disabled Whether or not the camera should be disabled.
1928     */
1929    public void setCameraDisabled(ComponentName admin, boolean disabled) {
1930        if (mService != null) {
1931            try {
1932                mService.setCameraDisabled(admin, disabled, UserHandle.myUserId());
1933            } catch (RemoteException e) {
1934                Log.w(TAG, "Failed talking with device policy service", e);
1935            }
1936        }
1937    }
1938
1939    /**
1940     * Determine whether or not the device's cameras have been disabled for this user,
1941     * either by the current admin, if specified, or all admins.
1942     * @param admin The name of the admin component to check, or null to check if any admins
1943     * have disabled the camera
1944     */
1945    public boolean getCameraDisabled(ComponentName admin) {
1946        return getCameraDisabled(admin, UserHandle.myUserId());
1947    }
1948
1949    /** @hide per-user version */
1950    public boolean getCameraDisabled(ComponentName admin, int userHandle) {
1951        if (mService != null) {
1952            try {
1953                return mService.getCameraDisabled(admin, userHandle);
1954            } catch (RemoteException e) {
1955                Log.w(TAG, "Failed talking with device policy service", e);
1956            }
1957        }
1958        return false;
1959    }
1960
1961    /**
1962     * Called by a device/profile owner to set whether the screen capture is disabled. Disabling
1963     * screen capture also prevents the content from being shown on display devices that do not have
1964     * a secure video output. See {@link android.view.Display#FLAG_SECURE} for more details about
1965     * secure surfaces and secure displays.
1966     *
1967     * <p>The calling device admin must be a device or profile owner. If it is not, a
1968     * security exception will be thrown.
1969     *
1970     * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
1971     * @param disabled Whether screen capture is disabled or not.
1972     */
1973    public void setScreenCaptureDisabled(ComponentName admin, boolean disabled) {
1974        if (mService != null) {
1975            try {
1976                mService.setScreenCaptureDisabled(admin, UserHandle.myUserId(), disabled);
1977            } catch (RemoteException e) {
1978                Log.w(TAG, "Failed talking with device policy service", e);
1979            }
1980        }
1981    }
1982
1983    /**
1984     * Determine whether or not screen capture has been disabled by the current
1985     * admin, if specified, or all admins.
1986     * @param admin The name of the admin component to check, or null to check if any admins
1987     * have disabled screen capture.
1988     */
1989    public boolean getScreenCaptureDisabled(ComponentName admin) {
1990        return getScreenCaptureDisabled(admin, UserHandle.myUserId());
1991    }
1992
1993    /** @hide per-user version */
1994    public boolean getScreenCaptureDisabled(ComponentName admin, int userHandle) {
1995        if (mService != null) {
1996            try {
1997                return mService.getScreenCaptureDisabled(admin, userHandle);
1998            } catch (RemoteException e) {
1999                Log.w(TAG, "Failed talking with device policy service", e);
2000            }
2001        }
2002        return false;
2003    }
2004
2005    /**
2006     * Called by a device owner to set whether auto time is required. If auto time is
2007     * required the user cannot set the date and time, but has to use network date and time.
2008     *
2009     * <p>Note: if auto time is required the user can still manually set the time zone.
2010     *
2011     * <p>The calling device admin must be a device owner. If it is not, a security exception will
2012     * be thrown.
2013     *
2014     * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
2015     * @param required Whether auto time is set required or not.
2016     */
2017    public void setAutoTimeRequired(ComponentName admin, boolean required) {
2018        if (mService != null) {
2019            try {
2020                mService.setAutoTimeRequired(admin, UserHandle.myUserId(), required);
2021            } catch (RemoteException e) {
2022                Log.w(TAG, "Failed talking with device policy service", e);
2023            }
2024        }
2025    }
2026
2027    /**
2028     * @return true if auto time is required.
2029     */
2030    public boolean getAutoTimeRequired() {
2031        if (mService != null) {
2032            try {
2033                return mService.getAutoTimeRequired();
2034            } catch (RemoteException e) {
2035                Log.w(TAG, "Failed talking with device policy service", e);
2036            }
2037        }
2038        return false;
2039    }
2040
2041    /**
2042     * Called by an application that is administering the device to disable keyguard customizations,
2043     * such as widgets. After setting this, keyguard features will be disabled according to the
2044     * provided feature list.
2045     *
2046     * <p>The calling device admin must have requested
2047     * {@link DeviceAdminInfo#USES_POLICY_DISABLE_KEYGUARD_FEATURES} to be able to call
2048     * this method; if it has not, a security exception will be thrown.
2049     *
2050     * <p>Calling this from a managed profile will throw a security exception.
2051     *
2052     * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
2053     * @param which {@link #KEYGUARD_DISABLE_FEATURES_NONE} (default),
2054     * {@link #KEYGUARD_DISABLE_WIDGETS_ALL}, {@link #KEYGUARD_DISABLE_SECURE_CAMERA},
2055     * {@link #KEYGUARD_DISABLE_SECURE_NOTIFICATIONS}, {@link #KEYGUARD_DISABLE_TRUST_AGENTS},
2056     * {@link #KEYGUARD_DISABLE_UNREDACTED_NOTIFICATIONS}, {@link #KEYGUARD_DISABLE_FEATURES_ALL}
2057     */
2058    public void setKeyguardDisabledFeatures(ComponentName admin, int which) {
2059        if (mService != null) {
2060            try {
2061                mService.setKeyguardDisabledFeatures(admin, which, UserHandle.myUserId());
2062            } catch (RemoteException e) {
2063                Log.w(TAG, "Failed talking with device policy service", e);
2064            }
2065        }
2066    }
2067
2068    /**
2069     * Determine whether or not features have been disabled in keyguard either by the current
2070     * admin, if specified, or all admins.
2071     * @param admin The name of the admin component to check, or null to check if any admins
2072     * have disabled features in keyguard.
2073     * @return bitfield of flags. See {@link #setKeyguardDisabledFeatures(ComponentName, int)}
2074     * for a list.
2075     */
2076    public int getKeyguardDisabledFeatures(ComponentName admin) {
2077        return getKeyguardDisabledFeatures(admin, UserHandle.myUserId());
2078    }
2079
2080    /** @hide per-user version */
2081    public int getKeyguardDisabledFeatures(ComponentName admin, int userHandle) {
2082        if (mService != null) {
2083            try {
2084                return mService.getKeyguardDisabledFeatures(admin, userHandle);
2085            } catch (RemoteException e) {
2086                Log.w(TAG, "Failed talking with device policy service", e);
2087            }
2088        }
2089        return KEYGUARD_DISABLE_FEATURES_NONE;
2090    }
2091
2092    /**
2093     * @hide
2094     */
2095    public void setActiveAdmin(ComponentName policyReceiver, boolean refreshing, int userHandle) {
2096        if (mService != null) {
2097            try {
2098                mService.setActiveAdmin(policyReceiver, refreshing, userHandle);
2099            } catch (RemoteException e) {
2100                Log.w(TAG, "Failed talking with device policy service", e);
2101            }
2102        }
2103    }
2104
2105    /**
2106     * @hide
2107     */
2108    public void setActiveAdmin(ComponentName policyReceiver, boolean refreshing) {
2109        setActiveAdmin(policyReceiver, refreshing, UserHandle.myUserId());
2110    }
2111
2112    /**
2113     * Returns the DeviceAdminInfo as defined by the administrator's package info & meta-data
2114     * @hide
2115     */
2116    public DeviceAdminInfo getAdminInfo(ComponentName cn) {
2117        ActivityInfo ai;
2118        try {
2119            ai = mContext.getPackageManager().getReceiverInfo(cn,
2120                    PackageManager.GET_META_DATA);
2121        } catch (PackageManager.NameNotFoundException e) {
2122            Log.w(TAG, "Unable to retrieve device policy " + cn, e);
2123            return null;
2124        }
2125
2126        ResolveInfo ri = new ResolveInfo();
2127        ri.activityInfo = ai;
2128
2129        try {
2130            return new DeviceAdminInfo(mContext, ri);
2131        } catch (XmlPullParserException e) {
2132            Log.w(TAG, "Unable to parse device policy " + cn, e);
2133            return null;
2134        } catch (IOException e) {
2135            Log.w(TAG, "Unable to parse device policy " + cn, e);
2136            return null;
2137        }
2138    }
2139
2140    /**
2141     * @hide
2142     */
2143    public void getRemoveWarning(ComponentName admin, RemoteCallback result) {
2144        if (mService != null) {
2145            try {
2146                mService.getRemoveWarning(admin, result, UserHandle.myUserId());
2147            } catch (RemoteException e) {
2148                Log.w(TAG, "Failed talking with device policy service", e);
2149            }
2150        }
2151    }
2152
2153    /**
2154     * @hide
2155     */
2156    public void setActivePasswordState(int quality, int length, int letters, int uppercase,
2157            int lowercase, int numbers, int symbols, int nonletter, int userHandle) {
2158        if (mService != null) {
2159            try {
2160                mService.setActivePasswordState(quality, length, letters, uppercase, lowercase,
2161                        numbers, symbols, nonletter, userHandle);
2162            } catch (RemoteException e) {
2163                Log.w(TAG, "Failed talking with device policy service", e);
2164            }
2165        }
2166    }
2167
2168    /**
2169     * @hide
2170     */
2171    public void reportFailedPasswordAttempt(int userHandle) {
2172        if (mService != null) {
2173            try {
2174                mService.reportFailedPasswordAttempt(userHandle);
2175            } catch (RemoteException e) {
2176                Log.w(TAG, "Failed talking with device policy service", e);
2177            }
2178        }
2179    }
2180
2181    /**
2182     * @hide
2183     */
2184    public void reportSuccessfulPasswordAttempt(int userHandle) {
2185        if (mService != null) {
2186            try {
2187                mService.reportSuccessfulPasswordAttempt(userHandle);
2188            } catch (RemoteException e) {
2189                Log.w(TAG, "Failed talking with device policy service", e);
2190            }
2191        }
2192    }
2193
2194    /**
2195     * @hide
2196     * Sets the given package as the device owner. The package must already be installed and there
2197     * shouldn't be an existing device owner registered, for this call to succeed. Also, this
2198     * method must be called before the device is provisioned.
2199     * @param packageName the package name of the application to be registered as the device owner.
2200     * @return whether the package was successfully registered as the device owner.
2201     * @throws IllegalArgumentException if the package name is null or invalid
2202     * @throws IllegalStateException if a device owner is already registered or the device has
2203     *         already been provisioned.
2204     */
2205    public boolean setDeviceOwner(String packageName) throws IllegalArgumentException,
2206            IllegalStateException {
2207        return setDeviceOwner(packageName, null);
2208    }
2209
2210    /**
2211     * @hide
2212     * Sets the given package as the device owner. The package must already be installed and there
2213     * shouldn't be an existing device owner registered, for this call to succeed. Also, this
2214     * method must be called before the device is provisioned.
2215     * @param packageName the package name of the application to be registered as the device owner.
2216     * @param ownerName the human readable name of the institution that owns this device.
2217     * @return whether the package was successfully registered as the device owner.
2218     * @throws IllegalArgumentException if the package name is null or invalid
2219     * @throws IllegalStateException if a device owner is already registered or the device has
2220     *         already been provisioned.
2221     */
2222    public boolean setDeviceOwner(String packageName, String ownerName)
2223            throws IllegalArgumentException, IllegalStateException {
2224        if (mService != null) {
2225            try {
2226                return mService.setDeviceOwner(packageName, ownerName);
2227            } catch (RemoteException re) {
2228                Log.w(TAG, "Failed to set device owner");
2229            }
2230        }
2231        return false;
2232    }
2233
2234    /**
2235     * Used to determine if a particular package has been registered as a Device Owner app.
2236     * A device owner app is a special device admin that cannot be deactivated by the user, once
2237     * activated as a device admin. It also cannot be uninstalled. To check if a particular
2238     * package is currently registered as the device owner app, pass in the package name from
2239     * {@link Context#getPackageName()} to this method.<p/>This is useful for device
2240     * admin apps that want to check if they are also registered as the device owner app. The
2241     * exact mechanism by which a device admin app is registered as a device owner app is defined by
2242     * the setup process.
2243     * @param packageName the package name of the app, to compare with the registered device owner
2244     * app, if any.
2245     * @return whether or not the package is registered as the device owner app.
2246     */
2247    public boolean isDeviceOwnerApp(String packageName) {
2248        if (mService != null) {
2249            try {
2250                return mService.isDeviceOwner(packageName);
2251            } catch (RemoteException re) {
2252                Log.w(TAG, "Failed to check device owner");
2253            }
2254        }
2255        return false;
2256    }
2257
2258    /**
2259     * @hide
2260     * Redirect to isDeviceOwnerApp.
2261     */
2262    public boolean isDeviceOwner(String packageName) {
2263        return isDeviceOwnerApp(packageName);
2264    }
2265
2266    /**
2267     * Clears the current device owner.  The caller must be the device owner.
2268     *
2269     * This function should be used cautiously as once it is called it cannot
2270     * be undone.  The device owner can only be set as a part of device setup
2271     * before setup completes.
2272     *
2273     * @param packageName The package name of the device owner.
2274     */
2275    public void clearDeviceOwnerApp(String packageName) {
2276        if (mService != null) {
2277            try {
2278                mService.clearDeviceOwner(packageName);
2279            } catch (RemoteException re) {
2280                Log.w(TAG, "Failed to clear device owner");
2281            }
2282        }
2283    }
2284
2285    /** @hide */
2286    @SystemApi
2287    public String getDeviceOwner() {
2288        if (mService != null) {
2289            try {
2290                return mService.getDeviceOwner();
2291            } catch (RemoteException re) {
2292                Log.w(TAG, "Failed to get device owner");
2293            }
2294        }
2295        return null;
2296    }
2297
2298    /** @hide */
2299    public String getDeviceOwnerName() {
2300        if (mService != null) {
2301            try {
2302                return mService.getDeviceOwnerName();
2303            } catch (RemoteException re) {
2304                Log.w(TAG, "Failed to get device owner");
2305            }
2306        }
2307        return null;
2308    }
2309
2310    /**
2311     * @hide
2312     * @deprecated Use #ACTION_SET_PROFILE_OWNER
2313     * Sets the given component as an active admin and registers the package as the profile
2314     * owner for this user. The package must already be installed and there shouldn't be
2315     * an existing profile owner registered for this user. Also, this method must be called
2316     * before the user setup has been completed.
2317     * <p>
2318     * This method can only be called by system apps that hold MANAGE_USERS permission and
2319     * MANAGE_DEVICE_ADMINS permission.
2320     * @param admin The component to register as an active admin and profile owner.
2321     * @param ownerName The user-visible name of the entity that is managing this user.
2322     * @return whether the admin was successfully registered as the profile owner.
2323     * @throws IllegalArgumentException if packageName is null, the package isn't installed, or
2324     *         the user has already been set up.
2325     */
2326    @SystemApi
2327    public boolean setActiveProfileOwner(ComponentName admin, String ownerName)
2328            throws IllegalArgumentException {
2329        if (mService != null) {
2330            try {
2331                final int myUserId = UserHandle.myUserId();
2332                mService.setActiveAdmin(admin, false, myUserId);
2333                return mService.setProfileOwner(admin, ownerName, myUserId);
2334            } catch (RemoteException re) {
2335                Log.w(TAG, "Failed to set profile owner " + re);
2336                throw new IllegalArgumentException("Couldn't set profile owner.", re);
2337            }
2338        }
2339        return false;
2340    }
2341
2342    /**
2343     * @hide
2344     * Clears the active profile owner and removes all user restrictions. The caller must
2345     * be from the same package as the active profile owner for this user, otherwise a
2346     * SecurityException will be thrown.
2347     *
2348     * @param admin The component to remove as the profile owner.
2349     * @return
2350     */
2351    @SystemApi
2352    public void clearProfileOwner(ComponentName admin) {
2353        if (mService != null) {
2354            try {
2355                mService.clearProfileOwner(admin);
2356            } catch (RemoteException re) {
2357                Log.w(TAG, "Failed to clear profile owner " + admin + re);
2358            }
2359        }
2360    }
2361
2362    /**
2363     * @hide
2364     * Checks if the user was already setup.
2365     */
2366    public boolean hasUserSetupCompleted() {
2367        if (mService != null) {
2368            try {
2369                return mService.hasUserSetupCompleted();
2370            } catch (RemoteException re) {
2371                Log.w(TAG, "Failed to check if user setup has completed");
2372            }
2373        }
2374        return true;
2375    }
2376
2377    /**
2378     * @deprecated Use setProfileOwner(ComponentName ...)
2379     * @hide
2380     * Sets the given package as the profile owner of the given user profile. The package must
2381     * already be installed and there shouldn't be an existing profile owner registered for this
2382     * user. Also, this method must be called before the user has been used for the first time.
2383     * @param packageName the package name of the application to be registered as profile owner.
2384     * @param ownerName the human readable name of the organisation associated with this DPM.
2385     * @param userHandle the userId to set the profile owner for.
2386     * @return whether the package was successfully registered as the profile owner.
2387     * @throws IllegalArgumentException if packageName is null, the package isn't installed, or
2388     *         the user has already been set up.
2389     */
2390    public boolean setProfileOwner(String packageName, String ownerName, int userHandle)
2391            throws IllegalArgumentException {
2392        if (packageName == null) {
2393            throw new NullPointerException("packageName cannot be null");
2394        }
2395        return setProfileOwner(new ComponentName(packageName, ""), ownerName, userHandle);
2396    }
2397
2398    /**
2399     * @hide
2400     * Sets the given component as the profile owner of the given user profile. The package must
2401     * already be installed and there shouldn't be an existing profile owner registered for this
2402     * user. Only the system can call this API if the user has already completed setup.
2403     * @param admin the component name to be registered as profile owner.
2404     * @param ownerName the human readable name of the organisation associated with this DPM.
2405     * @param userHandle the userId to set the profile owner for.
2406     * @return whether the component was successfully registered as the profile owner.
2407     * @throws IllegalArgumentException if admin is null, the package isn't installed, or
2408     *         the user has already been set up.
2409     */
2410    public boolean setProfileOwner(ComponentName admin, String ownerName, int userHandle)
2411            throws IllegalArgumentException {
2412        if (admin == null) {
2413            throw new NullPointerException("admin cannot be null");
2414        }
2415        if (mService != null) {
2416            try {
2417                if (ownerName == null) {
2418                    ownerName = "";
2419                }
2420                return mService.setProfileOwner(admin, ownerName, userHandle);
2421            } catch (RemoteException re) {
2422                Log.w(TAG, "Failed to set profile owner", re);
2423                throw new IllegalArgumentException("Couldn't set profile owner.", re);
2424            }
2425        }
2426        return false;
2427    }
2428
2429    /**
2430     * Sets the enabled state of the profile. A profile should be enabled only once it is ready to
2431     * be used. Only the profile owner can call this.
2432     *
2433     * @see #isProfileOwnerApp
2434     *
2435     * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
2436     */
2437    public void setProfileEnabled(ComponentName admin) {
2438        if (mService != null) {
2439            try {
2440                mService.setProfileEnabled(admin);
2441            } catch (RemoteException e) {
2442                Log.w(TAG, "Failed talking with device policy service", e);
2443            }
2444        }
2445    }
2446
2447    /**
2448     * Sets the name of the profile. In the device owner case it sets the name of the user
2449     * which it is called from. Only a profile owner or device owner can call this. If this is
2450     * never called by the profile or device owner, the name will be set to default values.
2451     *
2452     * @see #isProfileOwnerApp
2453     * @see #isDeviceOwnerApp
2454     *
2455     * @param profileName The name of the profile.
2456     */
2457    public void setProfileName(ComponentName who, String profileName) {
2458        if (mService != null) {
2459            try {
2460            mService.setProfileName(who, profileName);
2461        } catch (RemoteException e) {
2462            Log.w(TAG, "Failed talking with device policy service", e);
2463        }
2464    }
2465}
2466
2467    /**
2468     * Used to determine if a particular package is registered as the profile owner for the
2469     * current user. A profile owner is a special device admin that has additional privileges
2470     * within the profile.
2471     *
2472     * @param packageName The package name of the app to compare with the registered profile owner.
2473     * @return Whether or not the package is registered as the profile owner.
2474     */
2475    public boolean isProfileOwnerApp(String packageName) {
2476        if (mService != null) {
2477            try {
2478                ComponentName profileOwner = mService.getProfileOwner(
2479                        Process.myUserHandle().getIdentifier());
2480                return profileOwner != null
2481                        && profileOwner.getPackageName().equals(packageName);
2482            } catch (RemoteException re) {
2483                Log.w(TAG, "Failed to check profile owner");
2484            }
2485        }
2486        return false;
2487    }
2488
2489    /**
2490     * @hide
2491     * @return the packageName of the owner of the given user profile or null if no profile
2492     * owner has been set for that user.
2493     * @throws IllegalArgumentException if the userId is invalid.
2494     */
2495    @SystemApi
2496    public ComponentName getProfileOwner() throws IllegalArgumentException {
2497        return getProfileOwnerAsUser(Process.myUserHandle().getIdentifier());
2498    }
2499
2500    /**
2501     * @see #getProfileOwner()
2502     * @hide
2503     */
2504    public ComponentName getProfileOwnerAsUser(final int userId) throws IllegalArgumentException {
2505        if (mService != null) {
2506            try {
2507                return mService.getProfileOwner(userId);
2508            } catch (RemoteException re) {
2509                Log.w(TAG, "Failed to get profile owner");
2510                throw new IllegalArgumentException(
2511                        "Requested profile owner for invalid userId", re);
2512            }
2513        }
2514        return null;
2515    }
2516
2517    /**
2518     * @hide
2519     * @return the human readable name of the organisation associated with this DPM or null if
2520     *         one is not set.
2521     * @throws IllegalArgumentException if the userId is invalid.
2522     */
2523    public String getProfileOwnerName() throws IllegalArgumentException {
2524        if (mService != null) {
2525            try {
2526                return mService.getProfileOwnerName(Process.myUserHandle().getIdentifier());
2527            } catch (RemoteException re) {
2528                Log.w(TAG, "Failed to get profile owner");
2529                throw new IllegalArgumentException(
2530                        "Requested profile owner for invalid userId", re);
2531            }
2532        }
2533        return null;
2534    }
2535
2536    /**
2537     * @hide
2538     * @param user The user for whom to fetch the profile owner name, if any.
2539     * @return the human readable name of the organisation associated with this profile owner or
2540     *         null if one is not set.
2541     * @throws IllegalArgumentException if the userId is invalid.
2542     */
2543    @SystemApi
2544    public String getProfileOwnerNameAsUser(int userId) throws IllegalArgumentException {
2545        if (mService != null) {
2546            try {
2547                return mService.getProfileOwnerName(userId);
2548            } catch (RemoteException re) {
2549                Log.w(TAG, "Failed to get profile owner");
2550                throw new IllegalArgumentException(
2551                        "Requested profile owner for invalid userId", re);
2552            }
2553        }
2554        return null;
2555    }
2556
2557    /**
2558     * Called by a profile owner or device owner to add a default intent handler activity for
2559     * intents that match a certain intent filter. This activity will remain the default intent
2560     * handler even if the set of potential event handlers for the intent filter changes and if
2561     * the intent preferences are reset.
2562     *
2563     * <p>The default disambiguation mechanism takes over if the activity is not installed
2564     * (anymore). When the activity is (re)installed, it is automatically reset as default
2565     * intent handler for the filter.
2566     *
2567     * <p>The calling device admin must be a profile owner or device owner. If it is not, a
2568     * security exception will be thrown.
2569     *
2570     * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
2571     * @param filter The IntentFilter for which a default handler is added.
2572     * @param activity The Activity that is added as default intent handler.
2573     */
2574    public void addPersistentPreferredActivity(ComponentName admin, IntentFilter filter,
2575            ComponentName activity) {
2576        if (mService != null) {
2577            try {
2578                mService.addPersistentPreferredActivity(admin, filter, activity);
2579            } catch (RemoteException e) {
2580                Log.w(TAG, "Failed talking with device policy service", e);
2581            }
2582        }
2583    }
2584
2585    /**
2586     * Called by a profile owner or device owner to remove all persistent intent handler preferences
2587     * associated with the given package that were set by {@link #addPersistentPreferredActivity}.
2588     *
2589     * <p>The calling device admin must be a profile owner. If it is not, a security
2590     * exception will be thrown.
2591     *
2592     * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
2593     * @param packageName The name of the package for which preferences are removed.
2594     */
2595    public void clearPackagePersistentPreferredActivities(ComponentName admin,
2596            String packageName) {
2597        if (mService != null) {
2598            try {
2599                mService.clearPackagePersistentPreferredActivities(admin, packageName);
2600            } catch (RemoteException e) {
2601                Log.w(TAG, "Failed talking with device policy service", e);
2602            }
2603        }
2604    }
2605
2606    /**
2607     * Called by a profile or device owner to set the application restrictions for a given target
2608     * application running in the profile.
2609     *
2610     * <p>The provided {@link Bundle} consists of key-value pairs, where the types of values may be
2611     * boolean, int, String, or String[].
2612     *
2613     * <p>The application restrictions are only made visible to the target application and the
2614     * profile or device owner.
2615     *
2616     * <p>If the restrictions are not available yet, but may be applied in the near future,
2617     * the admin can notify the target application of that by adding
2618     * {@link UserManager#KEY_RESTRICTIONS_PENDING} to the settings parameter.
2619     *
2620     * <p>The calling device admin must be a profile or device owner; if it is not, a security
2621     * exception will be thrown.
2622     *
2623     * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
2624     * @param packageName The name of the package to update restricted settings for.
2625     * @param settings A {@link Bundle} to be parsed by the receiving application, conveying a new
2626     * set of active restrictions.
2627     *
2628     * @see UserManager#KEY_RESTRICTIONS_PENDING
2629     */
2630    public void setApplicationRestrictions(ComponentName admin, String packageName,
2631            Bundle settings) {
2632        if (mService != null) {
2633            try {
2634                mService.setApplicationRestrictions(admin, packageName, settings);
2635            } catch (RemoteException e) {
2636                Log.w(TAG, "Failed talking with device policy service", e);
2637            }
2638        }
2639    }
2640
2641    /**
2642     * Sets a list of configuration features to enable for a TrustAgent component. This is meant
2643     * to be used in conjunction with {@link #KEYGUARD_DISABLE_TRUST_AGENTS}, which disables all
2644     * trust agents but those enabled by this function call. If flag
2645     * {@link #KEYGUARD_DISABLE_TRUST_AGENTS} is not set, then this call has no effect.
2646     *
2647     * <p>The calling device admin must have requested
2648     * {@link DeviceAdminInfo#USES_POLICY_DISABLE_KEYGUARD_FEATURES} to be able to call
2649     * this method; if not, a security exception will be thrown.
2650     *
2651     * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
2652     * @param target Component name of the agent to be enabled.
2653     * @param options TrustAgent-specific feature bundle. If null for any admin, agent
2654     * will be strictly disabled according to the state of the
2655     *  {@link #KEYGUARD_DISABLE_TRUST_AGENTS} flag.
2656     * <p>If {@link #KEYGUARD_DISABLE_TRUST_AGENTS} is set and options is not null for all admins,
2657     * then it's up to the TrustAgent itself to aggregate the values from all device admins.
2658     * <p>Consult documentation for the specific TrustAgent to determine legal options parameters.
2659     */
2660    public void setTrustAgentConfiguration(ComponentName admin, ComponentName target,
2661            PersistableBundle options) {
2662        if (mService != null) {
2663            try {
2664                mService.setTrustAgentConfiguration(admin, target, options, UserHandle.myUserId());
2665            } catch (RemoteException e) {
2666                Log.w(TAG, "Failed talking with device policy service", e);
2667            }
2668        }
2669    }
2670
2671    /**
2672     * Gets configuration for the given trust agent based on aggregating all calls to
2673     * {@link #setTrustAgentConfiguration(ComponentName, ComponentName, PersistableBundle)} for
2674     * all device admins.
2675     *
2676     * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
2677     * @param agent Which component to get enabled features for.
2678     * @return configuration for the given trust agent.
2679     */
2680    public List<PersistableBundle> getTrustAgentConfiguration(ComponentName admin,
2681            ComponentName agent) {
2682        return getTrustAgentConfiguration(admin, agent, UserHandle.myUserId());
2683    }
2684
2685    /** @hide per-user version */
2686    public List<PersistableBundle> getTrustAgentConfiguration(ComponentName admin,
2687            ComponentName agent, int userHandle) {
2688        if (mService != null) {
2689            try {
2690                return mService.getTrustAgentConfiguration(admin, agent, userHandle);
2691            } catch (RemoteException e) {
2692                Log.w(TAG, "Failed talking with device policy service", e);
2693            }
2694        }
2695        return new ArrayList<PersistableBundle>(); // empty list
2696    }
2697
2698    /**
2699     * Called by a profile owner of a managed profile to set whether caller-Id information from
2700     * the managed profile will be shown in the parent profile, for incoming calls.
2701     *
2702     * <p>The calling device admin must be a profile owner. If it is not, a
2703     * security exception will be thrown.
2704     *
2705     * @param who Which {@link DeviceAdminReceiver} this request is associated with.
2706     * @param disabled If true caller-Id information in the managed profile is not displayed.
2707     */
2708    public void setCrossProfileCallerIdDisabled(ComponentName who, boolean disabled) {
2709        if (mService != null) {
2710            try {
2711                mService.setCrossProfileCallerIdDisabled(who, disabled);
2712            } catch (RemoteException e) {
2713                Log.w(TAG, "Failed talking with device policy service", e);
2714            }
2715        }
2716    }
2717
2718    /**
2719     * Called by a profile owner of a managed profile to determine whether or not caller-Id
2720     * information has been disabled.
2721     *
2722     * <p>The calling device admin must be a profile owner. If it is not, a
2723     * security exception will be thrown.
2724     *
2725     * @param who Which {@link DeviceAdminReceiver} this request is associated with.
2726     */
2727    public boolean getCrossProfileCallerIdDisabled(ComponentName who) {
2728        if (mService != null) {
2729            try {
2730                return mService.getCrossProfileCallerIdDisabled(who);
2731            } catch (RemoteException e) {
2732                Log.w(TAG, "Failed talking with device policy service", e);
2733            }
2734        }
2735        return false;
2736    }
2737
2738    /**
2739     * Determine whether or not caller-Id information has been disabled.
2740     *
2741     * @param userHandle The user for whom to check the caller-id permission
2742     * @hide
2743     */
2744    public boolean getCrossProfileCallerIdDisabled(UserHandle userHandle) {
2745        if (mService != null) {
2746            try {
2747                return mService.getCrossProfileCallerIdDisabledForUser(userHandle.getIdentifier());
2748            } catch (RemoteException e) {
2749                Log.w(TAG, "Failed talking with device policy service", e);
2750            }
2751        }
2752        return false;
2753    }
2754
2755    /**
2756     * Called by the profile owner of a managed profile so that some intents sent in the managed
2757     * profile can also be resolved in the parent, or vice versa.
2758     * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
2759     * @param filter The {@link IntentFilter} the intent has to match to be also resolved in the
2760     * other profile
2761     * @param flags {@link DevicePolicyManager#FLAG_MANAGED_CAN_ACCESS_PARENT} and
2762     * {@link DevicePolicyManager#FLAG_PARENT_CAN_ACCESS_MANAGED} are supported.
2763     */
2764    public void addCrossProfileIntentFilter(ComponentName admin, IntentFilter filter, int flags) {
2765        if (mService != null) {
2766            try {
2767                mService.addCrossProfileIntentFilter(admin, filter, flags);
2768            } catch (RemoteException e) {
2769                Log.w(TAG, "Failed talking with device policy service", e);
2770            }
2771        }
2772    }
2773
2774    /**
2775     * Called by a profile owner of a managed profile to remove the cross-profile intent filters
2776     * that go from the managed profile to the parent, or from the parent to the managed profile.
2777     * Only removes those that have been set by the profile owner.
2778     * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
2779     */
2780    public void clearCrossProfileIntentFilters(ComponentName admin) {
2781        if (mService != null) {
2782            try {
2783                mService.clearCrossProfileIntentFilters(admin);
2784            } catch (RemoteException e) {
2785                Log.w(TAG, "Failed talking with device policy service", e);
2786            }
2787        }
2788    }
2789
2790    /**
2791     * Called by a profile or device owner to set the permitted accessibility services. When
2792     * set by a device owner or profile owner the restriction applies to all profiles of the
2793     * user the device owner or profile owner is an admin for.
2794     *
2795     * By default the user can use any accessiblity service. When zero or more packages have
2796     * been added, accessiblity services that are not in the list and not part of the system
2797     * can not be enabled by the user.
2798     *
2799     * <p> Calling with a null value for the list disables the restriction so that all services
2800     * can be used, calling with an empty list only allows the builtin system's services.
2801     *
2802     * <p> System accesibility services are always available to the user the list can't modify
2803     * this.
2804     *
2805     * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
2806     * @param packageNames List of accessibility service package names.
2807     *
2808     * @return true if setting the restriction succeeded. It fail if there is
2809     * one or more non-system accessibility services enabled, that are not in the list.
2810     */
2811    public boolean setPermittedAccessibilityServices(ComponentName admin,
2812            List<String> packageNames) {
2813        if (mService != null) {
2814            try {
2815                return mService.setPermittedAccessibilityServices(admin, packageNames);
2816            } catch (RemoteException e) {
2817                Log.w(TAG, "Failed talking with device policy service", e);
2818            }
2819        }
2820        return false;
2821    }
2822
2823    /**
2824     * Returns the list of permitted accessibility services set by this device or profile owner.
2825     *
2826     * <p>An empty list means no accessibility services except system services are allowed.
2827     * Null means all accessibility services are allowed.
2828     *
2829     * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
2830     * @return List of accessiblity service package names.
2831     */
2832    public List<String> getPermittedAccessibilityServices(ComponentName admin) {
2833        if (mService != null) {
2834            try {
2835                return mService.getPermittedAccessibilityServices(admin);
2836            } catch (RemoteException e) {
2837                Log.w(TAG, "Failed talking with device policy service", e);
2838            }
2839        }
2840        return null;
2841    }
2842
2843    /**
2844     * Returns the list of accessibility services permitted by the device or profiles
2845     * owners of this user.
2846     *
2847     * <p>Null means all accessibility services are allowed, if a non-null list is returned
2848     * it will contain the intersection of the permitted lists for any device or profile
2849     * owners that apply to this user. It will also include any system accessibility services.
2850     *
2851     * @param userId which user to check for.
2852     * @return List of accessiblity service package names.
2853     * @hide
2854     */
2855     @SystemApi
2856     public List<String> getPermittedAccessibilityServices(int userId) {
2857        if (mService != null) {
2858            try {
2859                return mService.getPermittedAccessibilityServicesForUser(userId);
2860            } catch (RemoteException e) {
2861                Log.w(TAG, "Failed talking with device policy service", e);
2862            }
2863        }
2864        return null;
2865     }
2866
2867    /**
2868     * Called by a profile or device owner to set the permitted input methods services. When
2869     * set by a device owner or profile owner the restriction applies to all profiles of the
2870     * user the device owner or profile owner is an admin for.
2871     *
2872     * By default the user can use any input method. When zero or more packages have
2873     * been added, input method that are not in the list and not part of the system
2874     * can not be enabled by the user.
2875     *
2876     * This method will fail if it is called for a admin that is not for the foreground user
2877     * or a profile of the foreground user.
2878     *
2879     * <p> Calling with a null value for the list disables the restriction so that all input methods
2880     * can be used, calling with an empty list disables all but the system's own input methods.
2881     *
2882     * <p> System input methods are always available to the user this method can't modify this.
2883     *
2884     * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
2885     * @param packageNames List of input method package names.
2886     * @return true if setting the restriction succeeded. It will fail if there is
2887     *     one or more input method enabled, that are not in the list or user if the foreground
2888     *     user.
2889     */
2890    public boolean setPermittedInputMethods(ComponentName admin, List<String> packageNames) {
2891        if (mService != null) {
2892            try {
2893                return mService.setPermittedInputMethods(admin, packageNames);
2894            } catch (RemoteException e) {
2895                Log.w(TAG, "Failed talking with device policy service", e);
2896            }
2897        }
2898        return false;
2899    }
2900
2901
2902    /**
2903     * Returns the list of permitted input methods set by this device or profile owner.
2904     *
2905     * <p>An empty list means no input methods except system input methods are allowed.
2906     * Null means all input methods are allowed.
2907     *
2908     * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
2909     * @return List of input method package names.
2910     */
2911    public List<String> getPermittedInputMethods(ComponentName admin) {
2912        if (mService != null) {
2913            try {
2914                return mService.getPermittedInputMethods(admin);
2915            } catch (RemoteException e) {
2916                Log.w(TAG, "Failed talking with device policy service", e);
2917            }
2918        }
2919        return null;
2920    }
2921
2922    /**
2923     * Returns the list of input methods permitted by the device or profiles
2924     * owners of the current user.
2925     *
2926     * <p>Null means all input methods are allowed, if a non-null list is returned
2927     * it will contain the intersection of the permitted lists for any device or profile
2928     * owners that apply to this user. It will also include any system input methods.
2929     *
2930     * @return List of input method package names.
2931     * @hide
2932     */
2933    @SystemApi
2934    public List<String> getPermittedInputMethodsForCurrentUser() {
2935        if (mService != null) {
2936            try {
2937                return mService.getPermittedInputMethodsForCurrentUser();
2938            } catch (RemoteException e) {
2939                Log.w(TAG, "Failed talking with device policy service", e);
2940            }
2941        }
2942        return null;
2943    }
2944
2945    /**
2946     * Called by a device owner to create a user with the specified name. The UserHandle returned
2947     * by this method should not be persisted as user handles are recycled as users are removed and
2948     * created. If you need to persist an identifier for this user, use
2949     * {@link UserManager#getSerialNumberForUser}.
2950     *
2951     * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
2952     * @param name the user's name
2953     * @see UserHandle
2954     * @return the UserHandle object for the created user, or null if the user could not be created.
2955     */
2956    public UserHandle createUser(ComponentName admin, String name) {
2957        try {
2958            return mService.createUser(admin, name);
2959        } catch (RemoteException re) {
2960            Log.w(TAG, "Could not create a user", re);
2961        }
2962        return null;
2963    }
2964
2965    /**
2966     * Called by a device owner to create a user with the specified name. The UserHandle returned
2967     * by this method should not be persisted as user handles are recycled as users are removed and
2968     * created. If you need to persist an identifier for this user, use
2969     * {@link UserManager#getSerialNumberForUser}.  The new user will be started in the background
2970     * immediately.
2971     *
2972     * <p> profileOwnerComponent is the {@link DeviceAdminReceiver} to be the profile owner as well
2973     * as registered as an active admin on the new user.  The profile owner package will be
2974     * installed on the new user if it already is installed on the device.
2975     *
2976     * <p>If the optionalInitializeData is not null, then the extras will be passed to the
2977     * profileOwnerComponent when onEnable is called.
2978     *
2979     * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
2980     * @param name the user's name
2981     * @param ownerName the human readable name of the organisation associated with this DPM.
2982     * @param profileOwnerComponent The {@link DeviceAdminReceiver} that will be an active admin on
2983     *      the user.
2984     * @param adminExtras Extras that will be passed to onEnable of the admin receiver
2985     *      on the new user.
2986     * @see UserHandle
2987     * @return the UserHandle object for the created user, or null if the user could not be created.
2988     */
2989    public UserHandle createAndInitializeUser(ComponentName admin, String name, String ownerName,
2990            ComponentName profileOwnerComponent, Bundle adminExtras) {
2991        try {
2992            return mService.createAndInitializeUser(admin, name, ownerName, profileOwnerComponent,
2993                    adminExtras);
2994        } catch (RemoteException re) {
2995            Log.w(TAG, "Could not create a user", re);
2996        }
2997        return null;
2998    }
2999
3000    /**
3001     * Called by a device owner to remove a user and all associated data. The primary user can
3002     * not be removed.
3003     *
3004     * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
3005     * @param userHandle the user to remove.
3006     * @return {@code true} if the user was removed, {@code false} otherwise.
3007     */
3008    public boolean removeUser(ComponentName admin, UserHandle userHandle) {
3009        try {
3010            return mService.removeUser(admin, userHandle);
3011        } catch (RemoteException re) {
3012            Log.w(TAG, "Could not remove user ", re);
3013            return false;
3014        }
3015    }
3016
3017    /**
3018     * Called by a device owner to switch the specified user to the foreground.
3019     *
3020     * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
3021     * @param userHandle the user to switch to; null will switch to primary.
3022     * @return {@code true} if the switch was successful, {@code false} otherwise.
3023     *
3024     * @see Intent#ACTION_USER_FOREGROUND
3025     */
3026    public boolean switchUser(ComponentName admin, UserHandle userHandle) {
3027        try {
3028            return mService.switchUser(admin, userHandle);
3029        } catch (RemoteException re) {
3030            Log.w(TAG, "Could not switch user ", re);
3031            return false;
3032        }
3033    }
3034
3035    /**
3036     * Called by a profile or device owner to get the application restrictions for a given target
3037     * application running in the profile.
3038     *
3039     * <p>The calling device admin must be a profile or device owner; if it is not, a security
3040     * exception will be thrown.
3041     *
3042     * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
3043     * @param packageName The name of the package to fetch restricted settings of.
3044     * @return {@link Bundle} of settings corresponding to what was set last time
3045     * {@link DevicePolicyManager#setApplicationRestrictions} was called, or an empty {@link Bundle}
3046     * if no restrictions have been set.
3047     */
3048    public Bundle getApplicationRestrictions(ComponentName admin, String packageName) {
3049        if (mService != null) {
3050            try {
3051                return mService.getApplicationRestrictions(admin, packageName);
3052            } catch (RemoteException e) {
3053                Log.w(TAG, "Failed talking with device policy service", e);
3054            }
3055        }
3056        return null;
3057    }
3058
3059    /**
3060     * Called by a profile or device owner to set a user restriction specified
3061     * by the key.
3062     * <p>
3063     * The calling device admin must be a profile or device owner; if it is not,
3064     * a security exception will be thrown.
3065     *
3066     * @param admin Which {@link DeviceAdminReceiver} this request is associated
3067     *            with.
3068     * @param key The key of the restriction. See the constants in
3069     *            {@link android.os.UserManager} for the list of keys.
3070     */
3071    public void addUserRestriction(ComponentName admin, String key) {
3072        if (mService != null) {
3073            try {
3074                mService.setUserRestriction(admin, key, true);
3075            } catch (RemoteException e) {
3076                Log.w(TAG, "Failed talking with device policy service", e);
3077            }
3078        }
3079    }
3080
3081    /**
3082     * Called by a profile or device owner to clear a user restriction specified
3083     * by the key.
3084     * <p>
3085     * The calling device admin must be a profile or device owner; if it is not,
3086     * a security exception will be thrown.
3087     *
3088     * @param admin Which {@link DeviceAdminReceiver} this request is associated
3089     *            with.
3090     * @param key The key of the restriction. See the constants in
3091     *            {@link android.os.UserManager} for the list of keys.
3092     */
3093    public void clearUserRestriction(ComponentName admin, String key) {
3094        if (mService != null) {
3095            try {
3096                mService.setUserRestriction(admin, key, false);
3097            } catch (RemoteException e) {
3098                Log.w(TAG, "Failed talking with device policy service", e);
3099            }
3100        }
3101    }
3102
3103    /**
3104     * Called by device or profile owner to hide or unhide packages. When a package is hidden it
3105     * is unavailable for use, but the data and actual package file remain.
3106     *
3107     * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
3108     * @param packageName The name of the package to hide or unhide.
3109     * @param hidden {@code true} if the package should be hidden, {@code false} if it should be
3110     *                 unhidden.
3111     * @return boolean Whether the hidden setting of the package was successfully updated.
3112     */
3113    public boolean setApplicationHidden(ComponentName admin, String packageName,
3114            boolean hidden) {
3115        if (mService != null) {
3116            try {
3117                return mService.setApplicationHidden(admin, packageName, hidden);
3118            } catch (RemoteException e) {
3119                Log.w(TAG, "Failed talking with device policy service", e);
3120            }
3121        }
3122        return false;
3123    }
3124
3125    /**
3126     * Called by device or profile owner to determine if a package is hidden.
3127     *
3128     * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
3129     * @param packageName The name of the package to retrieve the hidden status of.
3130     * @return boolean {@code true} if the package is hidden, {@code false} otherwise.
3131     */
3132    public boolean isApplicationHidden(ComponentName admin, String packageName) {
3133        if (mService != null) {
3134            try {
3135                return mService.isApplicationHidden(admin, packageName);
3136            } catch (RemoteException e) {
3137                Log.w(TAG, "Failed talking with device policy service", e);
3138            }
3139        }
3140        return false;
3141    }
3142
3143    /**
3144     * Called by profile or device owner to re-enable a system app that was disabled by default
3145     * when the user was initialized.
3146     *
3147     * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
3148     * @param packageName The package to be re-enabled in the current profile.
3149     */
3150    public void enableSystemApp(ComponentName admin, String packageName) {
3151        if (mService != null) {
3152            try {
3153                mService.enableSystemApp(admin, packageName);
3154            } catch (RemoteException e) {
3155                Log.w(TAG, "Failed to install package: " + packageName);
3156            }
3157        }
3158    }
3159
3160    /**
3161     * Called by profile or device owner to re-enable system apps by intent that were disabled
3162     * by default when the user was initialized.
3163     *
3164     * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
3165     * @param intent An intent matching the app(s) to be installed. All apps that resolve for this
3166     *               intent will be re-enabled in the current profile.
3167     * @return int The number of activities that matched the intent and were installed.
3168     */
3169    public int enableSystemApp(ComponentName admin, Intent intent) {
3170        if (mService != null) {
3171            try {
3172                return mService.enableSystemAppWithIntent(admin, intent);
3173            } catch (RemoteException e) {
3174                Log.w(TAG, "Failed to install packages matching filter: " + intent);
3175            }
3176        }
3177        return 0;
3178    }
3179
3180    /**
3181     * Called by a device owner or profile owner to disable account management for a specific type
3182     * of account.
3183     *
3184     * <p>The calling device admin must be a device owner or profile owner. If it is not, a
3185     * security exception will be thrown.
3186     *
3187     * <p>When account management is disabled for an account type, adding or removing an account
3188     * of that type will not be possible.
3189     *
3190     * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
3191     * @param accountType For which account management is disabled or enabled.
3192     * @param disabled The boolean indicating that account management will be disabled (true) or
3193     * enabled (false).
3194     */
3195    public void setAccountManagementDisabled(ComponentName admin, String accountType,
3196            boolean disabled) {
3197        if (mService != null) {
3198            try {
3199                mService.setAccountManagementDisabled(admin, accountType, disabled);
3200            } catch (RemoteException e) {
3201                Log.w(TAG, "Failed talking with device policy service", e);
3202            }
3203        }
3204    }
3205
3206    /**
3207     * Gets the array of accounts for which account management is disabled by the profile owner.
3208     *
3209     * <p> Account management can be disabled/enabled by calling
3210     * {@link #setAccountManagementDisabled}.
3211     *
3212     * @return a list of account types for which account management has been disabled.
3213     *
3214     * @see #setAccountManagementDisabled
3215     */
3216    public String[] getAccountTypesWithManagementDisabled() {
3217        return getAccountTypesWithManagementDisabledAsUser(UserHandle.myUserId());
3218    }
3219
3220    /**
3221     * @see #getAccountTypesWithManagementDisabled()
3222     * @hide
3223     */
3224    public String[] getAccountTypesWithManagementDisabledAsUser(int userId) {
3225        if (mService != null) {
3226            try {
3227                return mService.getAccountTypesWithManagementDisabledAsUser(userId);
3228            } catch (RemoteException e) {
3229                Log.w(TAG, "Failed talking with device policy service", e);
3230            }
3231        }
3232
3233        return null;
3234    }
3235
3236    /**
3237     * Sets which packages may enter lock task mode.
3238     *
3239     * <p>Any packages that shares uid with an allowed package will also be allowed
3240     * to activate lock task.
3241     *
3242     * This function can only be called by the device owner.
3243     * @param packages The list of packages allowed to enter lock task mode
3244     * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
3245     *
3246     * @see Activity#startLockTask()
3247     * @see DeviceAdminReceiver#onLockTaskModeChanged(Context, Intent, boolean, String)
3248     * @see UserManager#DISALLOW_CREATE_WINDOWS
3249     */
3250    public void setLockTaskPackages(ComponentName admin, String[] packages)
3251            throws SecurityException {
3252        if (mService != null) {
3253            try {
3254                mService.setLockTaskPackages(admin, packages);
3255            } catch (RemoteException e) {
3256                Log.w(TAG, "Failed talking with device policy service", e);
3257            }
3258        }
3259    }
3260
3261    /**
3262     * This function returns the list of packages allowed to start the lock task mode.
3263     *
3264     * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
3265     * @hide
3266     */
3267    public String[] getLockTaskPackages(ComponentName admin) {
3268        if (mService != null) {
3269            try {
3270                return mService.getLockTaskPackages(admin);
3271            } catch (RemoteException e) {
3272                Log.w(TAG, "Failed talking with device policy service", e);
3273            }
3274        }
3275        return null;
3276    }
3277
3278    /**
3279     * This function lets the caller know whether the given component is allowed to start the
3280     * lock task mode.
3281     * @param pkg The package to check
3282     */
3283    public boolean isLockTaskPermitted(String pkg) {
3284        if (mService != null) {
3285            try {
3286                return mService.isLockTaskPermitted(pkg);
3287            } catch (RemoteException e) {
3288                Log.w(TAG, "Failed talking with device policy service", e);
3289            }
3290        }
3291        return false;
3292    }
3293
3294    /**
3295     * Called by device owners to update {@link Settings.Global} settings. Validation that the value
3296     * of the setting is in the correct form for the setting type should be performed by the caller.
3297     * <p>The settings that can be updated with this method are:
3298     * <ul>
3299     * <li>{@link Settings.Global#ADB_ENABLED}</li>
3300     * <li>{@link Settings.Global#AUTO_TIME}</li>
3301     * <li>{@link Settings.Global#AUTO_TIME_ZONE}</li>
3302     * <li>{@link Settings.Global#BLUETOOTH_ON}</li>
3303     * <li>{@link Settings.Global#DATA_ROAMING}</li>
3304     * <li>{@link Settings.Global#DEVELOPMENT_SETTINGS_ENABLED}</li>
3305     * <li>{@link Settings.Global#MODE_RINGER}</li>
3306     * <li>{@link Settings.Global#NETWORK_PREFERENCE}</li>
3307     * <li>{@link Settings.Global#USB_MASS_STORAGE_ENABLED}</li>
3308     * <li>{@link Settings.Global#WIFI_ON}</li>
3309     * <li>{@link Settings.Global#WIFI_SLEEP_POLICY}</li>
3310     * </ul>
3311     *
3312     * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
3313     * @param setting The name of the setting to update.
3314     * @param value The value to update the setting to.
3315     */
3316    public void setGlobalSetting(ComponentName admin, String setting, String value) {
3317        if (mService != null) {
3318            try {
3319                mService.setGlobalSetting(admin, setting, value);
3320            } catch (RemoteException e) {
3321                Log.w(TAG, "Failed talking with device policy service", e);
3322            }
3323        }
3324    }
3325
3326    /**
3327     * Called by profile or device owners to update {@link Settings.Secure} settings. Validation
3328     * that the value of the setting is in the correct form for the setting type should be performed
3329     * by the caller.
3330     * <p>The settings that can be updated by a profile or device owner with this method are:
3331     * <ul>
3332     * <li>{@link Settings.Secure#DEFAULT_INPUT_METHOD}</li>
3333     * <li>{@link Settings.Secure#INSTALL_NON_MARKET_APPS}</li>
3334     * <li>{@link Settings.Secure#SKIP_FIRST_USE_HINTS}</li>
3335     * </ul>
3336     * <p>A device owner can additionally update the following settings:
3337     * <ul>
3338     * <li>{@link Settings.Secure#LOCATION_MODE}</li>
3339     * </ul>
3340     * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
3341     * @param setting The name of the setting to update.
3342     * @param value The value to update the setting to.
3343     */
3344    public void setSecureSetting(ComponentName admin, String setting, String value) {
3345        if (mService != null) {
3346            try {
3347                mService.setSecureSetting(admin, setting, value);
3348            } catch (RemoteException e) {
3349                Log.w(TAG, "Failed talking with device policy service", e);
3350            }
3351        }
3352    }
3353
3354    /**
3355     * Designates a specific service component as the provider for
3356     * making permission requests of a local or remote administrator of the user.
3357     * <p/>
3358     * Only a profile owner can designate the restrictions provider.
3359     * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
3360     * @param provider The component name of the service that implements
3361     * {@link RestrictionsReceiver}. If this param is null,
3362     * it removes the restrictions provider previously assigned.
3363     */
3364    public void setRestrictionsProvider(ComponentName admin, ComponentName provider) {
3365        if (mService != null) {
3366            try {
3367                mService.setRestrictionsProvider(admin, provider);
3368            } catch (RemoteException re) {
3369                Log.w(TAG, "Failed to set permission provider on device policy service");
3370            }
3371        }
3372    }
3373
3374    /**
3375     * Called by profile or device owners to set the master volume mute on or off.
3376     *
3377     * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
3378     * @param on {@code true} to mute master volume, {@code false} to turn mute off.
3379     */
3380    public void setMasterVolumeMuted(ComponentName admin, boolean on) {
3381        if (mService != null) {
3382            try {
3383                mService.setMasterVolumeMuted(admin, on);
3384            } catch (RemoteException re) {
3385                Log.w(TAG, "Failed to setMasterMute on device policy service");
3386            }
3387        }
3388    }
3389
3390    /**
3391     * Called by profile or device owners to check whether the master volume mute is on or off.
3392     *
3393     * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
3394     * @return {@code true} if master volume is muted, {@code false} if it's not.
3395     */
3396    public boolean isMasterVolumeMuted(ComponentName admin) {
3397        if (mService != null) {
3398            try {
3399                return mService.isMasterVolumeMuted(admin);
3400            } catch (RemoteException re) {
3401                Log.w(TAG, "Failed to get isMasterMute on device policy service");
3402            }
3403        }
3404        return false;
3405    }
3406
3407    /**
3408     * Called by profile or device owners to change whether a user can uninstall
3409     * a package.
3410     *
3411     * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
3412     * @param packageName package to change.
3413     * @param uninstallBlocked true if the user shouldn't be able to uninstall the package.
3414     */
3415    public void setUninstallBlocked(ComponentName admin, String packageName,
3416            boolean uninstallBlocked) {
3417        if (mService != null) {
3418            try {
3419                mService.setUninstallBlocked(admin, packageName, uninstallBlocked);
3420            } catch (RemoteException re) {
3421                Log.w(TAG, "Failed to call block uninstall on device policy service");
3422            }
3423        }
3424    }
3425
3426    /**
3427     * Called by profile or device owners to check whether a user has been blocked from
3428     * uninstalling a package.
3429     *
3430     * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
3431     * @param packageName package to check.
3432     * @return true if the user shouldn't be able to uninstall the package.
3433     */
3434    public boolean isUninstallBlocked(ComponentName admin, String packageName) {
3435        if (mService != null) {
3436            try {
3437                return mService.isUninstallBlocked(admin, packageName);
3438            } catch (RemoteException re) {
3439                Log.w(TAG, "Failed to call block uninstall on device policy service");
3440            }
3441        }
3442        return false;
3443    }
3444
3445    /**
3446     * Called by the profile owner of a managed profile to enable widget providers from a
3447     * given package to be available in the parent profile. As a result the user will be able to
3448     * add widgets from the white-listed package running under the profile to a widget
3449     * host which runs under the parent profile, for example the home screen. Note that
3450     * a package may have zero or more provider components, where each component
3451     * provides a different widget type.
3452     * <p>
3453     * <strong>Note:</strong> By default no widget provider package is white-listed.
3454     * </p>
3455     *
3456     * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
3457     * @param packageName The package from which widget providers are white-listed.
3458     * @return Whether the package was added.
3459     *
3460     * @see #removeCrossProfileWidgetProvider(android.content.ComponentName, String)
3461     * @see #getCrossProfileWidgetProviders(android.content.ComponentName)
3462     */
3463    public boolean addCrossProfileWidgetProvider(ComponentName admin, String packageName) {
3464        if (mService != null) {
3465            try {
3466                return mService.addCrossProfileWidgetProvider(admin, packageName);
3467            } catch (RemoteException re) {
3468                Log.w(TAG, "Error calling addCrossProfileWidgetProvider", re);
3469            }
3470        }
3471        return false;
3472    }
3473
3474    /**
3475     * Called by the profile owner of a managed profile to disable widget providers from a given
3476     * package to be available in the parent profile. For this method to take effect the
3477     * package should have been added via {@link #addCrossProfileWidgetProvider(
3478     * android.content.ComponentName, String)}.
3479     * <p>
3480     * <strong>Note:</strong> By default no widget provider package is white-listed.
3481     * </p>
3482     *
3483     * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
3484     * @param packageName The package from which widget providers are no longer
3485     *     white-listed.
3486     * @return Whether the package was removed.
3487     *
3488     * @see #addCrossProfileWidgetProvider(android.content.ComponentName, String)
3489     * @see #getCrossProfileWidgetProviders(android.content.ComponentName)
3490     */
3491    public boolean removeCrossProfileWidgetProvider(ComponentName admin, String packageName) {
3492        if (mService != null) {
3493            try {
3494                return mService.removeCrossProfileWidgetProvider(admin, packageName);
3495            } catch (RemoteException re) {
3496                Log.w(TAG, "Error calling removeCrossProfileWidgetProvider", re);
3497            }
3498        }
3499        return false;
3500    }
3501
3502    /**
3503     * Called by the profile owner of a managed profile to query providers from which packages are
3504     * available in the parent profile.
3505     *
3506     * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
3507     * @return The white-listed package list.
3508     *
3509     * @see #addCrossProfileWidgetProvider(android.content.ComponentName, String)
3510     * @see #removeCrossProfileWidgetProvider(android.content.ComponentName, String)
3511     */
3512    public List<String> getCrossProfileWidgetProviders(ComponentName admin) {
3513        if (mService != null) {
3514            try {
3515                List<String> providers = mService.getCrossProfileWidgetProviders(admin);
3516                if (providers != null) {
3517                    return providers;
3518                }
3519            } catch (RemoteException re) {
3520                Log.w(TAG, "Error calling getCrossProfileWidgetProviders", re);
3521            }
3522        }
3523        return Collections.emptyList();
3524    }
3525}
3526