Donate to e Foundation | Murena handsets with /e/OS | Own a part of Murena! Learn more

Commit 5af0fc37 authored by Pavel Grafov's avatar Pavel Grafov
Browse files

Make admin argument nullable. 

This argument is not necessary when the caller is DO or PO and is
unavailable when the caller is not an admin.

Also update user restriction javadocs - the described behavior only
applies to permission-based callers, so shouldn't be in public API docs.

Bug: 336310649
Test: btest a.d.c.UserRestrictionsTest
Flag: EXEMPT Annotation change for existing API.
Change-Id: I9ecafbf8b068fc9b834da5dbe0eaecc2f4abe0c1
parent 92f601e8

core/api/current.txt

+3 −3
Original line number Diff line number Diff line
@@ -8099,7 +8099,7 @@ package android.app.admin { 
    method @RequiresPermission(value=android.Manifest.permission.MANAGE_DEVICE_POLICY_PROFILE_INTERACTION, conditional=true) public boolean addCrossProfileWidgetProvider(@Nullable android.content.ComponentName, String);

    method public int addOverrideApn(@NonNull android.content.ComponentName, @NonNull android.telephony.data.ApnSetting);

    method @RequiresPermission(value=android.Manifest.permission.MANAGE_DEVICE_POLICY_LOCK_TASK, conditional=true) public void addPersistentPreferredActivity(@Nullable android.content.ComponentName, android.content.IntentFilter, @NonNull android.content.ComponentName);

    method public void addUserRestriction(@NonNull android.content.ComponentName, String);

    method public void addUserRestriction(@Nullable android.content.ComponentName, String);

    method public void addUserRestrictionGlobally(@NonNull String);

    method public boolean bindDeviceAdminServiceAsUser(@NonNull android.content.ComponentName, @NonNull android.content.Intent, @NonNull android.content.ServiceConnection, int, @NonNull android.os.UserHandle);

    method public boolean bindDeviceAdminServiceAsUser(@NonNull android.content.ComponentName, @NonNull android.content.Intent, @NonNull android.content.ServiceConnection, @NonNull android.content.Context.BindServiceFlags, @NonNull android.os.UserHandle);
@@ -8111,7 +8111,7 @@ package android.app.admin { 
    method @RequiresPermission(value=android.Manifest.permission.MANAGE_DEVICE_POLICY_LOCK_TASK, conditional=true) public void clearPackagePersistentPreferredActivities(@Nullable android.content.ComponentName, String);

    method @Deprecated public void clearProfileOwner(@NonNull android.content.ComponentName);

    method @RequiresPermission(value=android.Manifest.permission.MANAGE_DEVICE_POLICY_RESET_PASSWORD, conditional=true) public boolean clearResetPasswordToken(@Nullable android.content.ComponentName);

    method public void clearUserRestriction(@NonNull android.content.ComponentName, String);

    method public void clearUserRestriction(@Nullable android.content.ComponentName, String);

    method public android.content.Intent createAdminSupportIntent(@NonNull String);

    method @Nullable public android.os.UserHandle createAndManageUser(@NonNull android.content.ComponentName, @NonNull String, @NonNull android.content.ComponentName, @Nullable android.os.PersistableBundle, int);

    method public void enableSystemApp(@NonNull android.content.ComponentName, String);
@@ -8171,7 +8171,7 @@ package android.app.admin { 
    method @Deprecated @ColorInt public int getOrganizationColor(@NonNull android.content.ComponentName);

    method @Nullable @RequiresPermission(value=android.Manifest.permission.MANAGE_DEVICE_POLICY_ORGANIZATION_IDENTITY, conditional=true) public CharSequence getOrganizationName(@Nullable android.content.ComponentName);

    method public java.util.List<android.telephony.data.ApnSetting> getOverrideApns(@NonNull android.content.ComponentName);

    method @NonNull public android.app.admin.DevicePolicyManager getParentProfileInstance(@NonNull android.content.ComponentName);

    method @NonNull public android.app.admin.DevicePolicyManager getParentProfileInstance(@Nullable android.content.ComponentName);

    method @RequiresPermission(anyOf={android.Manifest.permission.MANAGE_DEVICE_POLICY_LOCK_CREDENTIALS, android.Manifest.permission.REQUEST_PASSWORD_COMPLEXITY}, conditional=true) public int getPasswordComplexity();

    method public long getPasswordExpiration(@Nullable android.content.ComponentName);

    method public long getPasswordExpirationTimeout(@Nullable android.content.ComponentName);

core/java/android/app/admin/DevicePolicyManager.java

+19 −19
Original line number Diff line number Diff line
@@ -12099,13 +12099,6 @@ public class DevicePolicyManager { 
     * be enforced device-wide. These constants will also state in their documentation which

     * permission is required to manage the restriction using this API.

     *

     * <p>For callers targeting Android {@link android.os.Build.VERSION_CODES#UPSIDE_DOWN_CAKE} or

     * above, calling this API will result in applying the restriction locally on the calling user,

     * or locally on the parent profile if called from the

     * {@link DevicePolicyManager} instance obtained from

     * {@link #getParentProfileInstance(ComponentName)}. To set a restriction globally, call

     * {@link #addUserRestrictionGlobally} instead.

     *

     * <p>

     * Starting from {@link Build.VERSION_CODES#UPSIDE_DOWN_CAKE}, after the user restriction

     * policy has been set, {@link PolicyUpdateReceiver#onPolicySetResult(Context, String,
@@ -12126,13 +12119,18 @@ public class DevicePolicyManager { 
     * same parameters as PolicyUpdateReceiver#onPolicySetResult and the {@link PolicyUpdateResult}

     * will contain the reason why the policy changed.

     *

     * @param admin Which {@link DeviceAdminReceiver} this request is associated with.

     * @param admin Which {@link DeviceAdminReceiver} this request is associated with or

     * {@code null} if the caller is not a device admin.

     * @param key   The key of the restriction.

     * @throws SecurityException if {@code admin} is not a device or profile owner and if the caller

     * has not been granted the permission to set the given user restriction.

     */

    // NB: For permission-based callers using this API will result in applying the restriction

    // locally on the calling user or locally on the parent profile if called from through parent

    // instance. To set a restriction globally, call addUserRestrictionGlobally() instead.

    // Permission-based callers must target Android U or above.

    @SupportsCoexistence

    public void addUserRestriction(@NonNull ComponentName admin,

    public void addUserRestriction(@Nullable ComponentName admin,

            @UserManager.UserRestrictionKey String key) {

        if (mService != null) {

            try {
@@ -12267,10 +12265,6 @@ public class DevicePolicyManager { 
     * constants state in their documentation which permission is required to manage the restriction

     * using this API.

     *

     * <p>For callers targeting Android {@link android.os.Build.VERSION_CODES#UPSIDE_DOWN_CAKE} or

     * above, calling this API will result in clearing any local and global restriction with the

     * specified key that was previously set by the caller.

     *

     * <p>

     * Starting from {@link Build.VERSION_CODES#UPSIDE_DOWN_CAKE}, after the user restriction

     * policy has been cleared, {@link PolicyUpdateReceiver#onPolicySetResult(Context, String,
@@ -12291,13 +12285,17 @@ public class DevicePolicyManager { 
     * same parameters as PolicyUpdateReceiver#onPolicySetResult and the {@link PolicyUpdateResult}

     * will contain the reason why the policy changed.

     *

     * @param admin Which {@link DeviceAdminReceiver} this request is associated with.

     * @param admin Which {@link DeviceAdminReceiver} this request is associated with or

     * {@code null} if the caller is not a device admin.

     * @param key   The key of the restriction.

     * @throws SecurityException if {@code admin} is not a device or profile owner  and if the

     *  caller has not been granted the permission to set the given user restriction.

     */

    // NB: For permission-based callers using this API will result in clearing any local and global

    // restriction with the specified key that was previously set by the caller.

    // Permission-based callers must target Android U or above.

    @SupportsCoexistence

    public void clearUserRestriction(@NonNull ComponentName admin,

    public void clearUserRestriction(@Nullable ComponentName admin,

            @UserManager.UserRestrictionKey String key) {

        if (mService != null) {

            try {
@@ -14465,8 +14463,8 @@ public class DevicePolicyManager { 
    }















    /**













     * Called by the profile owner of a managed profile to obtain a {@link DevicePolicyManager}













     * whose calls act on the parent profile.













     * Called by the profile owner of a managed profile or other apps in a managed profile to













     * obtain a {@link DevicePolicyManager} whose calls act on the parent profile.















     *















     * <p>The following methods are supported for the parent instance, all other methods will















     * throw a SecurityException when called on the parent instance:










@@ -14523,10 +14521,12 @@ public class DevicePolicyManager {













     * <li>{@link #wipeData}</li>















     * </ul>















     *













     * @param admin Which {@link DeviceAdminReceiver} this request is associated with or













     *         {@code null} if the caller is not a profile owner.















     * @return a new instance of {@link DevicePolicyManager} that acts on the parent profile.













     * @throws SecurityException if {@code admin} is not a profile owner.













     * @throws SecurityException if the current user is not a managed profile.















     */













    public @NonNull DevicePolicyManager getParentProfileInstance(@NonNull ComponentName admin) {













    public @NonNull DevicePolicyManager getParentProfileInstance(@Nullable ComponentName admin) {















        throwIfParentInstance("getParentProfileInstance");















        UserManager um = mContext.getSystemService(UserManager.class);















        if (!um.isManagedProfile()) {