Merge "Per-display VDM activity policy APIs." into main (942e4d02) · Commits · e / os / android_frameworks_base

core/api/system-current.txt

+3 −0

Original line number	Diff line number	Diff line
		@@ -3465,6 +3465,7 @@ package android.companion.virtual {
		public static class VirtualDeviceManager.VirtualDevice implements java.lang.AutoCloseable {
		method public void addActivityListener(@NonNull java.util.concurrent.Executor, @NonNull android.companion.virtual.VirtualDeviceManager.ActivityListener);
		method @FlaggedApi("android.companion.virtual.flags.dynamic_policy") @RequiresPermission(android.Manifest.permission.CREATE_VIRTUAL_DEVICE) public void addActivityPolicyExemption(@NonNull android.content.ComponentName);
		method @FlaggedApi("android.companion.virtualdevice.flags.activity_control_api") @RequiresPermission(android.Manifest.permission.CREATE_VIRTUAL_DEVICE) public void addActivityPolicyExemption(@NonNull android.content.ComponentName, int);
		method public void addSoundEffectListener(@NonNull java.util.concurrent.Executor, @NonNull android.companion.virtual.VirtualDeviceManager.SoundEffectListener);
		method @RequiresPermission(android.Manifest.permission.CREATE_VIRTUAL_DEVICE) public void close();
		method @NonNull public android.content.Context createContext();
		@@ -3489,8 +3490,10 @@ package android.companion.virtual {
		method @RequiresPermission(android.Manifest.permission.CREATE_VIRTUAL_DEVICE) public void registerIntentInterceptor(@NonNull android.content.IntentFilter, @NonNull java.util.concurrent.Executor, @NonNull android.companion.virtual.VirtualDeviceManager.IntentInterceptorCallback);
		method public void removeActivityListener(@NonNull android.companion.virtual.VirtualDeviceManager.ActivityListener);
		method @FlaggedApi("android.companion.virtual.flags.dynamic_policy") @RequiresPermission(android.Manifest.permission.CREATE_VIRTUAL_DEVICE) public void removeActivityPolicyExemption(@NonNull android.content.ComponentName);
		method @FlaggedApi("android.companion.virtualdevice.flags.activity_control_api") @RequiresPermission(android.Manifest.permission.CREATE_VIRTUAL_DEVICE) public void removeActivityPolicyExemption(@NonNull android.content.ComponentName, int);
		method public void removeSoundEffectListener(@NonNull android.companion.virtual.VirtualDeviceManager.SoundEffectListener);
		method @FlaggedApi("android.companion.virtual.flags.dynamic_policy") @RequiresPermission(android.Manifest.permission.CREATE_VIRTUAL_DEVICE) public void setDevicePolicy(int, int);
		method @FlaggedApi("android.companion.virtualdevice.flags.activity_control_api") @RequiresPermission(android.Manifest.permission.CREATE_VIRTUAL_DEVICE) public void setDevicePolicy(int, int, int);
		method @FlaggedApi("android.companion.virtual.flags.vdm_custom_ime") @RequiresPermission(android.Manifest.permission.CREATE_VIRTUAL_DEVICE) public void setDisplayImePolicy(int, int);
		method @RequiresPermission(android.Manifest.permission.CREATE_VIRTUAL_DEVICE) public void setShowPointerIcon(boolean);
		method @RequiresPermission(android.Manifest.permission.CREATE_VIRTUAL_DEVICE) public void unregisterIntentInterceptor(@NonNull android.companion.virtual.VirtualDeviceManager.IntentInterceptorCallback);

core/java/android/companion/virtual/IVirtualDevice.aidl

+18 −0

Original line number	Diff line number	Diff line
		@@ -111,6 +111,24 @@ interface IVirtualDevice {
		@EnforcePermission("CREATE_VIRTUAL_DEVICE")
		void removeActivityPolicyExemption(in ComponentName exemption);

		/**
		* Specifies a policy for this virtual device on the given display.
		*/
		@EnforcePermission("CREATE_VIRTUAL_DEVICE")
		void setDevicePolicyForDisplay(int displayId, int policyType, int devicePolicy);

		/**
		* Adds an exemption to the default activity launch policy on the given display.
		*/
		@EnforcePermission("CREATE_VIRTUAL_DEVICE")
		void addActivityPolicyExemptionForDisplay(int displayId, in ComponentName exemption);

		/**
		* Removes an exemption to the default activity launch policy on the given display.
		*/
		@EnforcePermission("CREATE_VIRTUAL_DEVICE")
		void removeActivityPolicyExemptionForDisplay(int displayId, in ComponentName exemption);

		/**
		* Notifies that an audio session being started.
		*/

core/java/android/companion/virtual/VirtualDeviceInternal.java

+50 −0

Original line number	Diff line number	Diff line
		@@ -17,7 +17,11 @@
		package android.companion.virtual;

		import static android.companion.virtual.VirtualDeviceParams.DEVICE_POLICY_CUSTOM;
		import static android.companion.virtual.VirtualDeviceParams.POLICY_TYPE_ACTIVITY;
		import static android.companion.virtual.VirtualDeviceParams.POLICY_TYPE_AUDIO;
		import static android.companion.virtual.VirtualDeviceParams.POLICY_TYPE_BLOCKED_ACTIVITY_BEHAVIOR;
		import static android.companion.virtual.VirtualDeviceParams.POLICY_TYPE_CLIPBOARD;
		import static android.companion.virtual.VirtualDeviceParams.POLICY_TYPE_RECENTS;

		import android.annotation.CallbackExecutor;
		import android.annotation.NonNull;
		@@ -282,6 +286,16 @@ public class VirtualDeviceInternal {

		void setDevicePolicy(@VirtualDeviceParams.DynamicPolicyType int policyType,
		@VirtualDeviceParams.DevicePolicy int devicePolicy) {
		switch (policyType) {
		case POLICY_TYPE_RECENTS:
		case POLICY_TYPE_CLIPBOARD:
		case POLICY_TYPE_ACTIVITY:
		case POLICY_TYPE_BLOCKED_ACTIVITY_BEHAVIOR:
		break;
		default:
		throw new IllegalArgumentException("Device policy " + policyType
		+ " cannot be changed at runtime. ");
		}
		try {
		mVirtualDevice.setDevicePolicy(policyType, devicePolicy);
		} catch (RemoteException e) {
		@@ -305,6 +319,42 @@ public class VirtualDeviceInternal {
		}
		}

		void setDevicePolicyForDisplay(int displayId,
		@VirtualDeviceParams.DynamicDisplayPolicyType int policyType,
		@VirtualDeviceParams.DevicePolicy int devicePolicy) {
		switch (policyType) {
		case POLICY_TYPE_RECENTS:
		case POLICY_TYPE_ACTIVITY:
		break;
		default:
		throw new IllegalArgumentException("Device policy " + policyType
		+ " cannot be changed for a specific display. ");
		}

		try {
		mVirtualDevice.setDevicePolicyForDisplay(displayId, policyType, devicePolicy);
		} catch (RemoteException e) {
		throw e.rethrowFromSystemServer();
		}
		}

		void addActivityPolicyExemptionForDisplay(int displayId, @NonNull ComponentName componentName) {
		try {
		mVirtualDevice.addActivityPolicyExemptionForDisplay(displayId, componentName);
		} catch (RemoteException e) {
		throw e.rethrowFromSystemServer();
		}
		}

		void removeActivityPolicyExemptionForDisplay(int displayId,
		@NonNull ComponentName componentName) {
		try {
		mVirtualDevice.removeActivityPolicyExemptionForDisplay(displayId, componentName);
		} catch (RemoteException e) {
		throw e.rethrowFromSystemServer();
		}
		}

		@NonNull
		VirtualDpad createVirtualDpad(@NonNull VirtualDpadConfig config) {
		try {

core/java/android/companion/virtual/VirtualDeviceManager.java

+76 −0

Original line number	Diff line number	Diff line
		@@ -739,6 +739,7 @@ public final class VirtualDeviceManager {
		*
		* @param policyType the type of policy, i.e. which behavior to specify a policy for.
		* @param devicePolicy the value of the policy, i.e. how to interpret the device behavior.
		* @throws IllegalArgumentException if the policy cannot be changed at runtime.
		*
		* @see VirtualDeviceParams#POLICY_TYPE_RECENTS
		* @see VirtualDeviceParams#POLICY_TYPE_ACTIVITY
		@@ -796,6 +797,81 @@ public final class VirtualDeviceManager {
		Objects.requireNonNull(componentName));
		}

		/**
		* Specifies a policy for this virtual device to be applied on the given virtual display.
		* <p>
		* Any policy specified for a particular display takes precedence over the policy specified
		* for the device itself.
		* </p>
		*
		* @param policyType the type of policy, i.e. which behavior to specify a policy for.
		* @param devicePolicy the value of the policy, i.e. how to interpret the device behavior.
		* @param displayId the ID of the display, for which to apply the policy.
		* @throws IllegalArgumentException if the specified policy cannot be changed per
		* display or if the specified display does not belong to the virtual device.
		*
		* @see #setDevicePolicy(int, int)
		* @see VirtualDeviceParams#POLICY_TYPE_RECENTS
		* @see VirtualDeviceParams#POLICY_TYPE_ACTIVITY
		*/
		@FlaggedApi(android.companion.virtualdevice.flags.Flags.FLAG_ACTIVITY_CONTROL_API)
		@RequiresPermission(android.Manifest.permission.CREATE_VIRTUAL_DEVICE)
		public void setDevicePolicy(
		@VirtualDeviceParams.DynamicDisplayPolicyType int policyType,
		@VirtualDeviceParams.DevicePolicy int devicePolicy,
		int displayId) {
		mVirtualDeviceInternal.setDevicePolicyForDisplay(displayId, policyType, devicePolicy);
		}

		/**
		* Specifies a component name to be exempt from the given display's activity launch policy.
		*
		* <p>If the current {@link VirtualDeviceParams#POLICY_TYPE_ACTIVITY} allows activity
		* launches by default, (i.e. it is {@link VirtualDeviceParams#DEVICE_POLICY_DEFAULT}),
		* then the specified component will be blocked from launching.
		* If the current {@link VirtualDeviceParams#POLICY_TYPE_ACTIVITY} blocks activity launches
		* by default, (i.e. it is {@link VirtualDeviceParams#DEVICE_POLICY_CUSTOM}), then the
		* specified component will be allowed to launch.</p>
		*
		* <p>Note that changing the activity launch policy will clear current set of exempt
		* components.</p>
		* <p>Any change to the exemptions will only be applied for new activity launches.</p>
		*
		* @see #removeActivityPolicyExemption
		* @see #setDevicePolicy
		*/
		@FlaggedApi(android.companion.virtualdevice.flags.Flags.FLAG_ACTIVITY_CONTROL_API)
		@RequiresPermission(android.Manifest.permission.CREATE_VIRTUAL_DEVICE)
		public void addActivityPolicyExemption(
		@NonNull ComponentName componentName, int displayId) {
		mVirtualDeviceInternal.addActivityPolicyExemptionForDisplay(
		displayId, Objects.requireNonNull(componentName));
		}

		/**
		* Makes the specified component name adhere to the given display's activity launch policy.
		*
		* <p>If the current {@link VirtualDeviceParams#POLICY_TYPE_ACTIVITY} allows activity
		* launches by default, (i.e. it is {@link VirtualDeviceParams#DEVICE_POLICY_DEFAULT}),
		* then the specified component will be allowed to launch.
		* If the current {@link VirtualDeviceParams#POLICY_TYPE_ACTIVITY} blocks activity launches
		* by default, (i.e. it is {@link VirtualDeviceParams#DEVICE_POLICY_CUSTOM}), then the
		* specified component will be blocked from launching.</p>
		*
		* <p>Note that changing the activity launch policy will clear current set of exempt
		* components.</p>
		*
		* @see #addActivityPolicyExemption
		* @see #setDevicePolicy
		*/
		@FlaggedApi(android.companion.virtualdevice.flags.Flags.FLAG_ACTIVITY_CONTROL_API)
		@RequiresPermission(android.Manifest.permission.CREATE_VIRTUAL_DEVICE)
		public void removeActivityPolicyExemption(
		@NonNull ComponentName componentName, int displayId) {
		mVirtualDeviceInternal.removeActivityPolicyExemptionForDisplay(
		displayId, Objects.requireNonNull(componentName));
		}

		/**
		* Creates a virtual dpad.
		*

core/java/android/companion/virtual/VirtualDeviceParams.java

+16 −1

Original line number	Diff line number	Diff line
		@@ -159,7 +159,8 @@ public final class VirtualDeviceParams implements Parcelable {
		* @hide
		*/
		@IntDef(prefix = "POLICY_TYPE_", value = {POLICY_TYPE_SENSORS, POLICY_TYPE_AUDIO,
		POLICY_TYPE_RECENTS, POLICY_TYPE_ACTIVITY, POLICY_TYPE_CAMERA})
		POLICY_TYPE_RECENTS, POLICY_TYPE_ACTIVITY, POLICY_TYPE_CAMERA,
		POLICY_TYPE_BLOCKED_ACTIVITY_BEHAVIOR})
		@Retention(RetentionPolicy.SOURCE)
		@Target({ElementType.TYPE_PARAMETER, ElementType.TYPE_USE})
		public @interface PolicyType {}
		@@ -176,6 +177,17 @@ public final class VirtualDeviceParams implements Parcelable {
		@Target({ElementType.TYPE_PARAMETER, ElementType.TYPE_USE})
		public @interface DynamicPolicyType {}

		/**
		* Policy types that can be dynamically changed for a specific display.
		*
		* @see VirtualDeviceManager.VirtualDevice#setDevicePolicyForDisplay
		* @hide
		*/
		@IntDef(prefix = "POLICY_TYPE_", value = {POLICY_TYPE_RECENTS, POLICY_TYPE_ACTIVITY})
		@Retention(RetentionPolicy.SOURCE)
		@Target({ElementType.TYPE_PARAMETER, ElementType.TYPE_USE})
		public @interface DynamicDisplayPolicyType {}

		/**
		* Tells the sensor framework how to handle sensor requests from contexts associated with this
		* virtual device, namely the sensors returned by
		@@ -229,6 +241,8 @@ public final class VirtualDeviceParams implements Parcelable {
		* @see VirtualDeviceManager.VirtualDevice#addActivityPolicyExemption
		* @see VirtualDeviceManager.VirtualDevice#removeActivityPolicyExemption
		*/
		// TODO(b/333443509): Update the documentation of custom policy and link to the new policy
		// POLICY_TYPE_BLOCKED_ACTIVITY_BEHAVIOR
		@FlaggedApi(Flags.FLAG_DYNAMIC_POLICY)
		public static final int POLICY_TYPE_ACTIVITY = 3;

		@@ -276,6 +290,7 @@ public final class VirtualDeviceParams implements Parcelable {
		* experience on the virtual device.
		* </ul>
		*/
		// TODO(b/333443509): Link to POLICY_TYPE_ACTIVITY
		@FlaggedApi(android.companion.virtualdevice.flags.Flags.FLAG_ACTIVITY_CONTROL_API)
		public static final int POLICY_TYPE_BLOCKED_ACTIVITY_BEHAVIOR = 6;