services/core/java/com/android/server/pm/pkg/PackageStateInternal.java

/*
 * Copyright (C) 2020 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.pm.pkg;

import android.annotation.NonNull;
import android.annotation.Nullable;
import android.annotation.UserIdInt;
import android.content.pm.SigningDetails;
import android.util.SparseArray;

import com.android.internal.pm.parsing.pkg.AndroidPackageInternal;
import com.android.server.pm.InstallSource;
import com.android.server.pm.PackageKeySetData;
import com.android.server.pm.permission.LegacyPermissionState;

import java.util.UUID;

/**
 * Exposes internal types for internal usage of {@link PackageState}.
 * @hide
 */
public interface PackageStateInternal extends PackageState {

    @Nullable
    AndroidPackageInternal getPkg();

    // TODO: Remove in favor of exposing APIs directly?
    @NonNull
    PackageStateUnserialized getTransientState();

    @NonNull
    UUID getDomainSetId();

    @NonNull
    SigningDetails getSigningDetails();

    @NonNull
    InstallSource getInstallSource();

    // TODO: Remove this in favor of boolean APIs
    int getFlags();
    int getPrivateFlags();

    @NonNull
    SparseArray<? extends PackageUserStateInternal> getUserStates();

    /**
     * @return the result of {@link #getUserStates()}.get(userId) or
     * {@link PackageUserState#DEFAULT} if the state doesn't exist.
     */
    @NonNull
    default PackageUserStateInternal getUserStateOrDefault(@UserIdInt int userId) {
        PackageUserStateInternal userState = getUserStates().get(userId);
        return userState == null ? PackageUserStateInternal.DEFAULT : userState;
    }

    @NonNull
    LegacyPermissionState getLegacyPermissionState();

    @Nullable
    String getRealName();

    boolean isLoading();

    @NonNull
    String getPathString();

    float getLoadingProgress();

    long getLoadingCompletedTime();

    @NonNull
    PackageKeySetData getKeySetData();

    /**
     * Return the exact value stored inside this object for the primary CPU ABI type. This does
     * not fallback to the inner {@link #getAndroidPackage()}, unlike {@link #getPrimaryCpuAbi()}.
     *
     * @deprecated Use {@link #getPrimaryCpuAbi()} if at all possible.
     *
     * TODO(b/249779400): Remove and see if the fallback-only API is a usable replacement
     */
    @Deprecated
    @Nullable
    String getPrimaryCpuAbiLegacy();

    /**
     * Same behavior as {@link #getPrimaryCpuAbiLegacy()}, but with the secondary ABI.
     *
     * @deprecated Use {@link #getSecondaryCpuAbi()} if at all possible.
     */
    @Nullable
    String getSecondaryCpuAbiLegacy();

    /**
     * @return the app metadata file path.
     */
    @Nullable
    String getAppMetadataFilePath();
}