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

Commit c810e5c6 authored by Kenneth Ford's avatar Kenneth Ford Committed by Android (Google) Code Review
Browse files

Merge changes from topic "top-focused-DevStMan" into sc-v2-dev 

* changes:
  Allow top focused activities to call requestState
  Allow override requests to outlive the requesting process.
  Refactor request lifecycle logic into OverrideRequestController.
parents a7292658 1f70abe9

core/api/test-current.txt

+2 −2
Original line number Diff line number Diff line
@@ -1133,10 +1133,10 @@ package android.hardware.camera2 { 
package android.hardware.devicestate {



  public final class DeviceStateManager {

    method @RequiresPermission(android.Manifest.permission.CONTROL_DEVICE_STATE) public void cancelRequest(@NonNull android.hardware.devicestate.DeviceStateRequest);

    method @RequiresPermission(value=android.Manifest.permission.CONTROL_DEVICE_STATE, conditional=true) public void cancelRequest(@NonNull android.hardware.devicestate.DeviceStateRequest);

    method @NonNull public int[] getSupportedStates();

    method public void registerCallback(@NonNull java.util.concurrent.Executor, @NonNull android.hardware.devicestate.DeviceStateManager.DeviceStateCallback);

    method @RequiresPermission(android.Manifest.permission.CONTROL_DEVICE_STATE) public void requestState(@NonNull android.hardware.devicestate.DeviceStateRequest, @Nullable java.util.concurrent.Executor, @Nullable android.hardware.devicestate.DeviceStateRequest.Callback);

    method @RequiresPermission(value=android.Manifest.permission.CONTROL_DEVICE_STATE, conditional=true) public void requestState(@NonNull android.hardware.devicestate.DeviceStateRequest, @Nullable java.util.concurrent.Executor, @Nullable android.hardware.devicestate.DeviceStateRequest.Callback);

    method public void unregisterCallback(@NonNull android.hardware.devicestate.DeviceStateManager.DeviceStateCallback);

    field public static final int MAXIMUM_DEVICE_STATE = 255; // 0xff

    field public static final int MINIMUM_DEVICE_STATE = 0; // 0x0

core/java/android/hardware/devicestate/DeviceStateManager.java

+12 −10
Original line number Diff line number Diff line
@@ -75,23 +75,24 @@ public final class DeviceStateManager { 
    /**

     * Submits a {@link DeviceStateRequest request} to modify the device state.

     * <p>

     * By default, the request is kept active until a call to

     * {@link #cancelRequest(DeviceStateRequest)} or until one of the following occurs:

     * By default, the request is kept active until one of the following occurs:

     * <ul>

     *     <li>The system deems the request can no longer be honored, for example if the requested

     *     state becomes unsupported.

     *     <li>A call to {@link #cancelRequest(DeviceStateRequest)}.

     *     <li>Another processes submits a request succeeding this request in which case the request

     *     will be suspended until the interrupting request is canceled.

     *     <li>The requested state has become unsupported.

     *     <li>The process submitting the request dies.

     * </ul>

     * However, this behavior can be changed by setting flags on the {@link DeviceStateRequest}.

     *

     * @throws IllegalArgumentException if the requested state is unsupported.

     * @throws SecurityException if the {@link android.Manifest.permission#CONTROL_DEVICE_STATE}

     * permission is not held.

     * @throws SecurityException if the caller is neither the current top-focused activity nor if

     * the {@link android.Manifest.permission#CONTROL_DEVICE_STATE} permission is held.

     *

     * @see DeviceStateRequest

     */

    @RequiresPermission(android.Manifest.permission.CONTROL_DEVICE_STATE)

    @RequiresPermission(value = android.Manifest.permission.CONTROL_DEVICE_STATE,

            conditional = true)

    public void requestState(@NonNull DeviceStateRequest request,

            @Nullable @CallbackExecutor Executor executor,

            @Nullable DeviceStateRequest.Callback callback) {
@@ -105,10 +106,11 @@ public final class DeviceStateManager { 
     * This method is noop if the {@code request} has not been submitted with a call to

     * {@link #requestState(DeviceStateRequest, Executor, DeviceStateRequest.Callback)}.

     *

     * @throws SecurityException if the {@link android.Manifest.permission#CONTROL_DEVICE_STATE}

     * permission is not held.

     * @throws SecurityException if the caller is neither the current top-focused activity nor if

     * the {@link android.Manifest.permission#CONTROL_DEVICE_STATE} permission is held.

     */

    @RequiresPermission(android.Manifest.permission.CONTROL_DEVICE_STATE)

    @RequiresPermission(value = android.Manifest.permission.CONTROL_DEVICE_STATE,

            conditional = true)

    public void cancelRequest(@NonNull DeviceStateRequest request) {

        mGlobal.cancelRequest(request);

    }

services/core/java/com/android/server/devicestate/DeviceState.java

+30 −3
Original line number Diff line number Diff line
@@ -19,11 +19,14 @@ package com.android.server.devicestate; 
import static android.hardware.devicestate.DeviceStateManager.MAXIMUM_DEVICE_STATE;

import static android.hardware.devicestate.DeviceStateManager.MINIMUM_DEVICE_STATE;



import android.annotation.IntDef;

import android.annotation.IntRange;

import android.annotation.NonNull;



import com.android.internal.util.Preconditions;



import java.lang.annotation.Retention;

import java.lang.annotation.RetentionPolicy;

import java.util.Objects;



/**
@@ -39,6 +42,19 @@ import java.util.Objects; 
 * @see DeviceStateManagerService

 */

public final class DeviceState {

    /**

     * Flag that indicates sticky requests should be cancelled when this device state becomes the

     * base device state.

     */

    public static final int FLAG_CANCEL_STICKY_REQUESTS = 1 << 0;



    /** @hide */

    @IntDef(prefix = {"FLAG_"}, flag = true, value = {

            FLAG_CANCEL_STICKY_REQUESTS,

    })

    @Retention(RetentionPolicy.SOURCE)

    public @interface DeviceStateFlags {}



    /** Unique identifier for the device state. */

    @IntRange(from = MINIMUM_DEVICE_STATE, to = MAXIMUM_DEVICE_STATE)

    private final int mIdentifier;
@@ -47,14 +63,19 @@ public final class DeviceState { 
    @NonNull

    private final String mName;



    @DeviceStateFlags

    private final int mFlags;



    public DeviceState(

            @IntRange(from = MINIMUM_DEVICE_STATE, to = MAXIMUM_DEVICE_STATE) int identifier,

            @NonNull String name) {

            @NonNull String name,

            @DeviceStateFlags int flags) {

        Preconditions.checkArgumentInRange(identifier, MINIMUM_DEVICE_STATE, MAXIMUM_DEVICE_STATE,

                "identifier");



        mIdentifier = identifier;

        mName = name;

        mFlags = flags;

    }



    /** Returns the unique identifier for the device state. */
@@ -69,6 +90,11 @@ public final class DeviceState { 
        return mName;

    }



    @DeviceStateFlags

    public int getFlags() {

        return mFlags;

    }



    @Override

    public String toString() {

        return "DeviceState{" + "identifier=" + mIdentifier + ", name='" + mName + '\'' + '}';
@@ -80,11 +106,12 @@ public final class DeviceState { 
        if (o == null || getClass() != o.getClass()) return false;

        DeviceState that = (DeviceState) o;

        return mIdentifier == that.mIdentifier

                && Objects.equals(mName, that.mName);

                && Objects.equals(mName, that.mName)

                && mFlags == that.mFlags;

    }



    @Override

    public int hashCode() {

        return Objects.hash(mIdentifier, mName);

        return Objects.hash(mIdentifier, mName, mFlags);

    }

}

services/core/java/com/android/server/devicestate/DeviceStateManagerService.java

+242 −291

File changed.

Preview size limit exceeded, changes collapsed.

services/core/java/com/android/server/devicestate/OverrideRequest.java

0 → 100644
+58 −0
Original line number Diff line number Diff line 
/*

 * Copyright (C) 2021 The Android Open Source Project

 *

 * Licensed under the Apache License, Version 2.0 (the "License");

 * you may not use this file except in compliance with the License.

 * You may obtain a copy of the License at

 *

 *      http://www.apache.org/licenses/LICENSE-2.0

 *

 * Unless required by applicable law or agreed to in writing, software

 * distributed under the License is distributed on an "AS IS" BASIS,

 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.

 * See the License for the specific language governing permissions and

 * limitations under the License.

 */



package com.android.server.devicestate;



import android.hardware.devicestate.DeviceStateRequest;

import android.os.IBinder;



/**

 * A request to override the state managed by {@link DeviceStateManagerService}.

 *

 * @see OverrideRequestController

 */

final class OverrideRequest {

    private final IBinder mToken;

    private final int mPid;

    private final int mRequestedState;

    @DeviceStateRequest.RequestFlags

    private final int mFlags;



    OverrideRequest(IBinder token, int pid, int requestedState,

            @DeviceStateRequest.RequestFlags int flags) {

        mToken = token;

        mPid = pid;

        mRequestedState = requestedState;

        mFlags = flags;

    }



    IBinder getToken() {

        return mToken;

    }



    int getPid() {

        return mPid;

    }



    int getRequestedState() {

        return mRequestedState;

    }



    @DeviceStateRequest.RequestFlags

    int getFlags() {

        return mFlags;

    }

}