Android/frameworks_base
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Add an API to get the details of all virtual devices.

Browse Source 
Expose minimal information about a virtual device in `VirtualDevice` and allow clients to access it via VDM.

Bug: 239152561
Test: atest VirtualDeviceTest, CTS sent separately
Change-Id: I7e21009444205925707821692888dad50b58316f
This commit is contained in:
Vladimir Komsiyski
2022-10-05 12:45:56 +02:00
parent fa42e5b625
commit 156763aa02
10 changed files with 311 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
core/api/current.txt
View File

@@ -9069,6 +9069,18 @@ package android.companion {
}
package android.companion.virtual {
public final class VirtualDevice implements android.os.Parcelable {
method public int describeContents();
method public int getDeviceId();
method @Nullable public String getName();
method public void writeToParcel(@NonNull android.os.Parcel, int);
field @NonNull public static final android.os.Parcelable.Creator<android.companion.virtual.VirtualDevice> CREATOR;
}
}
package android.content {
public abstract class AbstractThreadedSyncAdapter {

3
core/api/system-current.txt
View File

@@ -2789,6 +2789,7 @@ package android.companion.virtual {
public final class VirtualDeviceManager {
method @NonNull @RequiresPermission(android.Manifest.permission.CREATE_VIRTUAL_DEVICE) public android.companion.virtual.VirtualDeviceManager.VirtualDevice createVirtualDevice(int, @NonNull android.companion.virtual.VirtualDeviceParams);
method @NonNull public java.util.List<android.companion.virtual.VirtualDevice> getVirtualDevices();
field public static final int DEFAULT_DEVICE_ID = 0; // 0x0
field public static final int INVALID_DEVICE_ID = -1; // 0xffffffff
field public static final int LAUNCH_FAILURE_NO_ACTIVITY = 2; // 0x2
@@ -2825,6 +2826,7 @@ package android.companion.virtual {
method public int getDefaultActivityPolicy();
method public int getDefaultNavigationPolicy();
method public int getLockState();
method @Nullable public String getName();
method @NonNull public java.util.Set<android.os.UserHandle> getUsersWithMatchingAccounts();
method public void writeToParcel(@NonNull android.os.Parcel, int);
field public static final int ACTIVITY_POLICY_DEFAULT_ALLOWED = 0; // 0x0
@@ -2844,6 +2846,7 @@ package android.companion.virtual {
method @NonNull public android.companion.virtual.VirtualDeviceParams.Builder setBlockedActivities(@NonNull java.util.Set<android.content.ComponentName>);
method @NonNull public android.companion.virtual.VirtualDeviceParams.Builder setBlockedCrossTaskNavigations(@NonNull java.util.Set<android.content.ComponentName>);
method @NonNull @RequiresPermission(value=android.Manifest.permission.ADD_ALWAYS_UNLOCKED_DISPLAY, conditional=true) public android.companion.virtual.VirtualDeviceParams.Builder setLockState(int);
method @NonNull public android.companion.virtual.VirtualDeviceParams.Builder setName(@NonNull String);
method @NonNull public android.companion.virtual.VirtualDeviceParams.Builder setUsersWithMatchingAccounts(@NonNull java.util.Set<android.os.UserHandle>);
}

6
core/java/android/companion/virtual/IVirtualDeviceManager.aidl
View File

@@ -18,6 +18,7 @@ package android.companion.virtual;
import android.companion.virtual.IVirtualDevice;
import android.companion.virtual.IVirtualDeviceActivityListener;
import android.companion.virtual.VirtualDevice;
import android.companion.virtual.VirtualDeviceParams;
import android.hardware.display.IVirtualDisplayCallback;
import android.hardware.display.VirtualDisplayConfig;
@@ -45,6 +46,11 @@ interface IVirtualDeviceManager {
in IBinder token, String packageName, int associationId,
in VirtualDeviceParams params, in IVirtualDeviceActivityListener activityListener);
/**
* Returns the details of all available virtual devices.
*/
List<VirtualDevice> getVirtualDevices();
/**
* Creates a virtual display owned by a particular virtual device.
*

19
core/java/android/companion/virtual/VirtualDevice.aidl Normal file
View File

@@ -0,0 +1,19 @@
/*
* Copyright (C) 2022 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 android.companion.virtual;
parcelable VirtualDevice;

119
core/java/android/companion/virtual/VirtualDevice.java Normal file
View File

@@ -0,0 +1,119 @@
/*
* Copyright (C) 2022 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 android.companion.virtual;
import android.annotation.NonNull;
import android.annotation.Nullable;
import android.os.Parcel;
import android.os.Parcelable;
import java.util.Objects;
/**
* Details of a particular virtual device.
*/
public final class VirtualDevice implements Parcelable {
private final int mId;
private final @Nullable String mName;
/**
* Creates a new instance of {@link VirtualDevice}.
* Only to be used by the VirtualDeviceManagerService.
*
* @hide
*/
public VirtualDevice(int id, @Nullable String name) {
if (id <= VirtualDeviceManager.DEFAULT_DEVICE_ID) {
throw new IllegalArgumentException("VirtualDevice ID mist be greater than "
+ VirtualDeviceManager.DEFAULT_DEVICE_ID);
}
mId = id;
mName = name;
}
private VirtualDevice(@NonNull Parcel parcel) {
mId = parcel.readInt();
mName = parcel.readString8();
}
/**
* Returns the unique ID of the virtual device.
*/
public int getDeviceId() {
return mId;
}
/**
* Returns the name of the virtual device (optionally) provided during its creation.
*
* @see VirtualDeviceParams.Builder#setName(String)
*/
public @Nullable String getName() {
return mName;
}
@Override
public int describeContents() {
return 0;
}
@Override
public void writeToParcel(@NonNull Parcel dest, int flags) {
dest.writeInt(mId);
dest.writeString8(mName);
}
@Override
public boolean equals(Object o) {
if (this == o) {
return true;
}
if (!(o instanceof VirtualDevice)) {
return false;
}
VirtualDevice that = (VirtualDevice) o;
return mId == that.mId
&& Objects.equals(mName, that.mName);
}
@Override
public int hashCode() {
return Objects.hash(mId, mName);
}
@Override
@NonNull
public String toString() {
return "VirtualDevice("
+ " mId=" + mId
+ " mName=" + mName
+ ")";
}
@NonNull
public static final Parcelable.Creator<VirtualDevice> CREATOR =
new Parcelable.Creator<VirtualDevice>() {
public VirtualDevice createFromParcel(Parcel in) {
return new VirtualDevice(in);
}
public VirtualDevice[] newArray(int size) {
return new VirtualDevice[size];
}
};
}

19
core/java/android/companion/virtual/VirtualDeviceManager.java
View File

@@ -49,12 +49,15 @@ import android.os.Looper;
import android.os.RemoteException;
import android.os.ResultReceiver;
import android.util.ArrayMap;
import android.util.Log;
import android.view.Surface;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
import java.util.ArrayList;
import java.util.List;
import java.util.concurrent.Executor;
import java.util.function.IntConsumer;
@@ -153,6 +156,22 @@ public final class VirtualDeviceManager {
}
}
/**
* Returns the details of all available virtual devices.
*/
@NonNull
public List<android.companion.virtual.VirtualDevice> getVirtualDevices() {
if (mService == null) {
Log.w(TAG, "Failed to retrieve virtual devices; no virtual device manager service.");
return new ArrayList<>();
}
try {
return mService.getVirtualDevices();
} catch (RemoteException e) {
throw e.rethrowFromSystemServer();
}
}
/**
* A virtual device has its own virtual display, audio output, microphone, and camera etc. The
* creator of a virtual device can take the output from the virtual display and stream it over

43
core/java/android/companion/virtual/VirtualDeviceParams.java
View File

@@ -20,6 +20,7 @@ import static android.Manifest.permission.ADD_ALWAYS_UNLOCKED_DISPLAY;
import android.annotation.IntDef;
import android.annotation.NonNull;
import android.annotation.Nullable;
import android.annotation.RequiresPermission;
import android.annotation.SystemApi;
import android.content.ComponentName;
@@ -112,6 +113,7 @@ public final class VirtualDeviceParams implements Parcelable {
@NonNull private final ArraySet<ComponentName> mBlockedActivities;
@ActivityPolicy
private final int mDefaultActivityPolicy;
@Nullable private final String mName;
private VirtualDeviceParams(
@LockState int lockState,
@@ -121,7 +123,8 @@ public final class VirtualDeviceParams implements Parcelable {
@NavigationPolicy int defaultNavigationPolicy,
@NonNull Set<ComponentName> allowedActivities,
@NonNull Set<ComponentName> blockedActivities,
@ActivityPolicy int defaultActivityPolicy) {
@ActivityPolicy int defaultActivityPolicy,
@Nullable String name) {
Preconditions.checkNotNull(usersWithMatchingAccounts);
Preconditions.checkNotNull(allowedCrossTaskNavigations);
Preconditions.checkNotNull(blockedCrossTaskNavigations);
@@ -136,6 +139,7 @@ public final class VirtualDeviceParams implements Parcelable {
mAllowedActivities = new ArraySet<>(allowedActivities);
mBlockedActivities = new ArraySet<>(blockedActivities);
mDefaultActivityPolicy = defaultActivityPolicy;
mName = name;
}
@SuppressWarnings("unchecked")
@@ -148,6 +152,7 @@ public final class VirtualDeviceParams implements Parcelable {
mAllowedActivities = (ArraySet<ComponentName>) parcel.readArraySet(null);
mBlockedActivities = (ArraySet<ComponentName>) parcel.readArraySet(null);
mDefaultActivityPolicy = parcel.readInt();
mName = parcel.readString8();
}
/**
@@ -243,6 +248,16 @@ public final class VirtualDeviceParams implements Parcelable {
return mDefaultActivityPolicy;
}
/**
* Returns the (optional) name of the virtual device.
*
* @see Builder#setName
*/
@Nullable
public String getName() {
return mName;
}
@Override
public int describeContents() {
return 0;
@@ -258,6 +273,7 @@ public final class VirtualDeviceParams implements Parcelable {
dest.writeArraySet(mAllowedActivities);
dest.writeArraySet(mBlockedActivities);
dest.writeInt(mDefaultActivityPolicy);
dest.writeString8(mName);
}
@Override
@@ -276,7 +292,8 @@ public final class VirtualDeviceParams implements Parcelable {
&& mDefaultNavigationPolicy == that.mDefaultNavigationPolicy
&& Objects.equals(mAllowedActivities, that.mAllowedActivities)
&& Objects.equals(mBlockedActivities, that.mBlockedActivities)
&& mDefaultActivityPolicy == that.mDefaultActivityPolicy;
&& mDefaultActivityPolicy == that.mDefaultActivityPolicy
&& Objects.equals(mName, that.mName);
}
@Override
@@ -284,7 +301,7 @@ public final class VirtualDeviceParams implements Parcelable {
return Objects.hash(
mLockState, mUsersWithMatchingAccounts, mAllowedCrossTaskNavigations,
mBlockedCrossTaskNavigations, mDefaultNavigationPolicy, mAllowedActivities,
mBlockedActivities, mDefaultActivityPolicy);
mBlockedActivities, mDefaultActivityPolicy, mName);
}
@Override
@@ -299,6 +316,7 @@ public final class VirtualDeviceParams implements Parcelable {
+ " mAllowedActivities=" + mAllowedActivities
+ " mBlockedActivities=" + mBlockedActivities
+ " mDefaultActivityPolicy=" + mDefaultActivityPolicy
+ " mName=" + mName
+ ")";
}
@@ -331,6 +349,7 @@ public final class VirtualDeviceParams implements Parcelable {
@ActivityPolicy
private int mDefaultActivityPolicy = ACTIVITY_POLICY_DEFAULT_ALLOWED;
private boolean mDefaultActivityPolicyConfigured = false;
@Nullable private String mName;
/**
* Sets the lock state of the device. The permission {@code ADD_ALWAYS_UNLOCKED_DISPLAY}
@@ -493,6 +512,21 @@ public final class VirtualDeviceParams implements Parcelable {
return this;
}
/**
* Sets the optional virtual device name.
*
* <p>This string is not typically intended to be displayed to end users, but rather for
* debugging and other developer-facing purposes.
*
* <p>3rd party applications may be able to see the name (i.e. it's not private to the
* device owner)
*/
@NonNull
public Builder setName(@NonNull String name) {
mName = name;
return this;
}
/**
* Builds the {@link VirtualDeviceParams} instance.
*/
@@ -506,7 +540,8 @@ public final class VirtualDeviceParams implements Parcelable {
mDefaultNavigationPolicy,
mAllowedActivities,
mBlockedActivities,
mDefaultActivityPolicy);
mDefaultActivityPolicy,
mName);
}
}
}

5
services/companion/java/com/android/server/companion/virtual/VirtualDeviceImpl.java
View File

@@ -222,6 +222,11 @@ final class VirtualDeviceImpl extends IVirtualDevice.Stub
return mAssociationInfo.getDisplayName();
}
/** Returns the optional name of the device. */
String getDeviceName() {
return mParams.getName();
}
/** Returns the unique device ID of this device. */
@Override // Binder call
public int getDeviceId() {

14
services/companion/java/com/android/server/companion/virtual/VirtualDeviceManagerService.java
View File

@@ -28,6 +28,7 @@ import android.companion.CompanionDeviceManager.OnAssociationsChangedListener;
import android.companion.virtual.IVirtualDevice;
import android.companion.virtual.IVirtualDeviceActivityListener;
import android.companion.virtual.IVirtualDeviceManager;
import android.companion.virtual.VirtualDevice;
import android.companion.virtual.VirtualDeviceManager;
import android.companion.virtual.VirtualDeviceParams;
import android.content.Context;
@@ -344,6 +345,19 @@ public class VirtualDeviceManagerService extends SystemService {
return displayId;
}
@Override // Binder call
public List<VirtualDevice> getVirtualDevices() {
List<VirtualDevice> virtualDevices = new ArrayList<>();
synchronized (mVirtualDeviceManagerLock) {
for (int i = 0; i < mVirtualDevices.size(); i++) {
final VirtualDeviceImpl device = mVirtualDevices.valueAt(i);
virtualDevices.add(
new VirtualDevice(device.getDeviceId(), device.getDeviceName()));
}
}
return virtualDevices;
}
@Nullable
private AssociationInfo getAssociationInfo(String packageName, int associationId) {
final int callingUserId = getCallingUserHandle().getIdentifier();

75
services/tests/servicestests/src/com/android/server/companion/virtual/VirtualDeviceTest.java Normal file
View File

@@ -0,0 +1,75 @@
/*
* Copyright (C) 2022 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.companion.virtual;
import static android.companion.virtual.VirtualDeviceManager.DEFAULT_DEVICE_ID;
import static android.companion.virtual.VirtualDeviceManager.INVALID_DEVICE_ID;
import static com.google.common.truth.Truth.assertThat;
import static org.junit.Assert.assertThrows;
import android.companion.virtual.VirtualDevice;
import android.os.Parcel;
import androidx.test.ext.junit.runners.AndroidJUnit4;
import org.junit.Test;
import org.junit.runner.RunWith;
@RunWith(AndroidJUnit4.class)
public class VirtualDeviceTest {
private static final int VIRTUAL_DEVICE_ID = 42;
private static final String VIRTUAL_DEVICE_NAME = "VirtualDeviceName";
@Test
public void build_invalidId_shouldThrowIllegalArgumentException() {
assertThrows(
IllegalArgumentException.class,
() -> new VirtualDevice(INVALID_DEVICE_ID, VIRTUAL_DEVICE_NAME));
}
@Test
public void build_defaultId_shouldThrowIllegalArgumentException() {
assertThrows(
IllegalArgumentException.class,
() -> new VirtualDevice(DEFAULT_DEVICE_ID, VIRTUAL_DEVICE_NAME));
}
@Test
public void build_nameIsOptional() {
VirtualDevice virtualDevice =
new VirtualDevice(VIRTUAL_DEVICE_ID, /* name= */ null);
assertThat(virtualDevice.getDeviceId()).isEqualTo(VIRTUAL_DEVICE_ID);
assertThat(virtualDevice.getName()).isNull();
}
@Test
public void parcelable_shouldRecreateSuccessfully() {
VirtualDevice originalDevice =
new VirtualDevice(VIRTUAL_DEVICE_ID, VIRTUAL_DEVICE_NAME);
Parcel parcel = Parcel.obtain();
originalDevice.writeToParcel(parcel, 0);
parcel.setDataPosition(0);
VirtualDevice device = VirtualDevice.CREATOR.createFromParcel(parcel);
assertThat(device).isEqualTo(originalDevice);
assertThat(device.getDeviceId()).isEqualTo(VIRTUAL_DEVICE_ID);
assertThat(device.getName()).isEqualTo(VIRTUAL_DEVICE_NAME);
}
}