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

Commit 84c6d950 authored by Arthur Ishiguro's avatar Arthur Ishiguro Committed by Android (Google) Code Review
Browse files

Merge "Expose NanoAppRpcService from nanoapps"

parents e1d00c2d 3fcc716b
Loading
Loading
Loading
Loading
+11 −0
Original line number Diff line number Diff line
@@ -4366,13 +4366,24 @@ package android.hardware.location {
    field @NonNull public static final android.os.Parcelable.Creator<android.hardware.location.NanoAppMessage> CREATOR;
  }
  public final class NanoAppRpcService implements android.os.Parcelable {
    ctor public NanoAppRpcService(long, int);
    method public int describeContents();
    method public long getId();
    method public int getVersion();
    method public void writeToParcel(@NonNull android.os.Parcel, int);
    field @NonNull public static final android.os.Parcelable.Creator<android.hardware.location.NanoAppRpcService> CREATOR;
  }
  public final class NanoAppState implements android.os.Parcelable {
    ctor public NanoAppState(long, int, boolean);
    ctor public NanoAppState(long, int, boolean, @NonNull java.util.List<java.lang.String>);
    ctor public NanoAppState(long, int, boolean, @NonNull java.util.List<java.lang.String>, @NonNull java.util.List<android.hardware.location.NanoAppRpcService>);
    method public int describeContents();
    method public long getNanoAppId();
    method @NonNull public java.util.List<java.lang.String> getNanoAppPermissions();
    method public long getNanoAppVersion();
    method @NonNull public java.util.List<android.hardware.location.NanoAppRpcService> getRpcServices();
    method public boolean isEnabled();
    method public void writeToParcel(android.os.Parcel, int);
    field @NonNull public static final android.os.Parcelable.Creator<android.hardware.location.NanoAppState> CREATOR;
+22 −0
Original line number Diff line number Diff line
/*
 * Copyright 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 android.hardware.location;

/**
 * @hide
 */
parcelable NanoAppRpcService;
+159 −0
Original line number Diff line number Diff line
/*
 * Copyright 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 android.hardware.location;

import android.annotation.NonNull;
import android.annotation.Nullable;
import android.annotation.SystemApi;
import android.os.Parcel;
import android.os.Parcelable;

/**
 * An RPC service published by a nanoapp.
 *
 * This class is meant to be informational and allows a nanoapp client to know if a given
 * nanoapp publishes a service which supports an RPC interface. The implementation of the RPC
 * interface is not specified by the Android APIs and is built by the platform implementation
 * over the message payloads transferred through the {@link ContextHubClient}.
 *
 * This class is instantiated as a part of {@link NanoAppState}, which is provided as a result
 * of {@link ContextHubManager.queryNanoApps(ContextHubInfo)}.
 *
 * See the chrePublishRpcServices() API for how this service is published by the nanoapp.
 *
 * @hide
 */
@SystemApi
public final class NanoAppRpcService implements Parcelable {
    private long mServiceId;

    private int mServiceVersion;

    /**
     * @param serviceId The unique ID of this service, see {#getId()}.
     * @param serviceVersion The software version of this service, see {#getVersion()}.
     */
    public NanoAppRpcService(long serviceId, int serviceVersion) {
        mServiceId = serviceId;
        mServiceVersion = serviceVersion;
    }

    /**
     * The unique 64-bit ID of an RPC service published by a nanoapp. Note that
     * the uniqueness is only required within the nanoapp's domain (i.e. the
     * combination of the nanoapp ID and service id must be unique).
     *
     * This ID must remain the same for the given nanoapp RPC service once
     * published on Android (i.e. must never change).
     *
     * @return The service ID.
     */
    public long getId() {
        return mServiceId;
    }

    /**
     * The software version of this service, which follows the sematic
     * versioning scheme (see semver.org). It follows the format
     * major.minor.patch, where major and minor versions take up one byte
     * each, and the patch version takes up the final 2 (lower) bytes.
     * I.e. the version is encoded as 0xMMmmpppp, where MM, mm, pppp are
     * the major, minor, patch versions, respectively.
     *
     * @return The service version.
     */
    public int getVersion() {
        return mServiceVersion;
    }

    /**
     * @return The service's major version.
     */
    private int getMajorVersion() {
        return (mServiceVersion & 0xFF000000) >>> 24;
    }

    /**
     * @return The service's minor version.
     */
    private int getMinorVersion() {
        return (mServiceVersion & 0x00FF0000) >>> 16;
    }

    /**
     * @return The service's patch version.
     */
    private int getPatchVersion() {
        return mServiceVersion & 0x0000FFFF;
    }

    private NanoAppRpcService(Parcel in) {
        mServiceId = in.readLong();
        mServiceVersion = in.readInt();
    }

    @Override
    public int describeContents() {
        return 0;
    }

    @Override
    public void writeToParcel(@NonNull Parcel out, int flags) {
        out.writeLong(mServiceId);
        out.writeInt(mServiceVersion);
    }

    public static final @NonNull Creator<NanoAppRpcService> CREATOR =
            new Creator<NanoAppRpcService>() {
                @Override
                public NanoAppRpcService createFromParcel(Parcel in) {
                    return new NanoAppRpcService(in);
                }

                @Override
                public NanoAppRpcService[] newArray(int size) {
                    return new NanoAppRpcService[size];
                }
            };

    @NonNull
    @Override
    public String toString() {
        return "NanoAppRpcService[Id = " + Long.toHexString(mServiceId) + ", version = v"
                + getMajorVersion() + "." + getMinorVersion() + "." + getPatchVersion() + "]";
    }

    @Override
    public boolean equals(@Nullable Object object) {
        if (object == this) {
            return true;
        }

        boolean isEqual = false;
        if (object instanceof NanoAppRpcService) {
            NanoAppRpcService other = (NanoAppRpcService) object;
            isEqual = (other.getId() == mServiceId)
                    && (other.getVersion() == mServiceVersion);
        }

        return isEqual;
    }

    @Override
    public int hashCode() {
        return (int) getId();
    }
}
+63 −6
Original line number Diff line number Diff line
@@ -21,10 +21,16 @@ import android.os.Parcel;
import android.os.Parcelable;

import java.util.ArrayList;
import java.util.Arrays;
import java.util.Collections;
import java.util.List;

/**
 * A class describing the nanoapp state information resulting from a query to a Context Hub.
 * A class describing the nanoapp state information resulting from a query to a Context Hub
 * through {@link ContextHubManager.queryNanoApps(ContextHubInfo)}. It contains metadata about
 * the nanoapp running on a Context Hub.
 *
 * See "struct chreNanoappInfo" in the CHRE API (system/chre/chre_api) for additional details.
 *
 * @hide
 */
@@ -33,31 +39,70 @@ public final class NanoAppState implements Parcelable {
    private long mNanoAppId;
    private int mNanoAppVersion;
    private boolean mIsEnabled;
    private List<String> mNanoAppPermissions;
    private List<String> mNanoAppPermissions = new ArrayList<String>();
    private List<NanoAppRpcService> mNanoAppRpcServiceList =
                new ArrayList<NanoAppRpcService>();

    /**
     * @param nanoAppId The unique ID of this nanoapp, see {#getNanoAppId()}.
     * @param appVersion The software version of this nanoapp, see {#getNanoAppVersion()}.
     * @param enabled True if the nanoapp is enabled and running on the Context Hub.
     */
    public NanoAppState(long nanoAppId, int appVersion, boolean enabled) {
        mNanoAppId = nanoAppId;
        mNanoAppVersion = appVersion;
        mIsEnabled = enabled;
        mNanoAppPermissions = new ArrayList<String>();
    }

    /**
     * @param nanoAppId The unique ID of this nanoapp, see {#getNanoAppId()}.
     * @param appVersion The software version of this nanoapp, see {#getNanoAppVersion()}.
     * @param enabled True if the nanoapp is enabled and running on the Context Hub.
     * @param nanoAppPersmissions The list of permissions required to communicate with this
     *   nanoapp.
     */
    public NanoAppState(long nanoAppId, int appVersion, boolean enabled,
                        @NonNull List<String> nanoAppPermissions) {
        mNanoAppId = nanoAppId;
        mNanoAppVersion = appVersion;
        mIsEnabled = enabled;
        mNanoAppPermissions = nanoAppPermissions;
        mNanoAppPermissions = Collections.unmodifiableList(nanoAppPermissions);
    }

    /**
     * @return the NanoAppInfo for this app
     * @param nanoAppId The unique ID of this nanoapp, see {#getNanoAppId()}.
     * @param appVersion The software version of this nanoapp, see {#getNanoAppVersion()}.
     * @param enabled True if the nanoapp is enabled and running on the Context Hub.
     * @param nanoAppPersmissions The list of permissions required to communicate with this
     *   nanoapp.
     * @param nanoAppRpcServiceList The list of RPC services published by this nanoapp, see
     *   {@link NanoAppRpcService} for additional details.
     */
    public NanoAppState(long nanoAppId, int appVersion, boolean enabled,
                        @NonNull List<String> nanoAppPermissions,
                        @NonNull List<NanoAppRpcService> nanoAppRpcServiceList) {
        mNanoAppId = nanoAppId;
        mNanoAppVersion = appVersion;
        mIsEnabled = enabled;
        mNanoAppPermissions = Collections.unmodifiableList(nanoAppPermissions);
        mNanoAppRpcServiceList = Collections.unmodifiableList(nanoAppRpcServiceList);
    }

    /**
     * @return the unique ID of this nanoapp, which must never change once released on Android.
     */
    public long getNanoAppId() {
        return mNanoAppId;
    }

    /**
     * The software version of this service, which follows the sematic
     * versioning scheme (see semver.org). It follows the format
     * major.minor.patch, where major and minor versions take up one byte
     * each, and the patch version takes up the final 2 (lower) bytes.
     * I.e. the version is encoded as 0xMMmmpppp, where MM, mm, pppp are
     * the major, minor, patch versions, respectively.
     *
     * @return the app version
     */
    public long getNanoAppVersion() {
@@ -72,18 +117,29 @@ public final class NanoAppState implements Parcelable {
    }

    /**
     * @return List of Android permissions that are required to communicate with this app.
     * @return A read-only list of Android permissions that are all required to communicate with
     *   this nanoapp.
     */
    public @NonNull List<String> getNanoAppPermissions() {
        return mNanoAppPermissions;
    }

    /**
     * @return A read-only list of RPC services supported by this nanoapp.
     */
    public @NonNull List<NanoAppRpcService> getRpcServices() {
        return mNanoAppRpcServiceList;
    }

    private NanoAppState(Parcel in) {
        mNanoAppId = in.readLong();
        mNanoAppVersion = in.readInt();
        mIsEnabled = (in.readInt() == 1);
        mNanoAppPermissions = new ArrayList<String>();
        in.readStringList(mNanoAppPermissions);
        mNanoAppRpcServiceList = Collections.unmodifiableList(
                    Arrays.asList(in.readParcelableArray(
                    NanoAppRpcService.class.getClassLoader(), NanoAppRpcService.class)));
    }

    @Override
@@ -97,6 +153,7 @@ public final class NanoAppState implements Parcelable {
        out.writeInt(mNanoAppVersion);
        out.writeInt(mIsEnabled ? 1 : 0);
        out.writeStringList(mNanoAppPermissions);
        out.writeParcelableArray(mNanoAppRpcServiceList.toArray(new NanoAppRpcService[0]), 0);
    }

    public static final @android.annotation.NonNull Creator<NanoAppState> CREATOR =
+7 −1
Original line number Diff line number Diff line
@@ -29,6 +29,7 @@ import android.hardware.location.ContextHubInfo;
import android.hardware.location.ContextHubTransaction;
import android.hardware.location.NanoAppBinary;
import android.hardware.location.NanoAppMessage;
import android.hardware.location.NanoAppRpcService;
import android.hardware.location.NanoAppState;
import android.util.Log;

@@ -211,9 +212,14 @@ import java.util.List;
            android.hardware.contexthub.NanoappInfo[] nanoAppInfoList) {
        ArrayList<NanoAppState> nanoAppStateList = new ArrayList<>();
        for (android.hardware.contexthub.NanoappInfo appInfo : nanoAppInfoList) {
            ArrayList<NanoAppRpcService> rpcServiceList = new ArrayList<>();
            for (android.hardware.contexthub.NanoappRpcService service : appInfo.rpcServices) {
                rpcServiceList.add(new NanoAppRpcService(service.id, service.version));
            }
            nanoAppStateList.add(
                    new NanoAppState(appInfo.nanoappId, appInfo.nanoappVersion,
                            appInfo.enabled, new ArrayList<>(Arrays.asList(appInfo.permissions))));
                            appInfo.enabled, new ArrayList<>(Arrays.asList(appInfo.permissions)),
                            rpcServiceList));
        }

        return nanoAppStateList;