| /* |
| * Copyright (C) 2015 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.os.storage; |
| |
| import android.annotation.NonNull; |
| import android.annotation.Nullable; |
| import android.os.IVold; |
| |
| import java.util.Set; |
| |
| /** |
| * Mount service local interface. |
| * |
| * @hide Only for use within the system server. |
| */ |
| public abstract class StorageManagerInternal { |
| |
| /** |
| * Policy that influences how external storage is mounted and reported. |
| */ |
| public interface ExternalStorageMountPolicy { |
| /** |
| * Gets the external storage mount mode for the given uid. |
| * |
| * @param uid The UID for which to determine mount mode. |
| * @param packageName The package in the UID for making the call. |
| * @return The mount mode. |
| * |
| * @see com.android.internal.os.Zygote#MOUNT_EXTERNAL_NONE |
| * @see com.android.internal.os.Zygote#MOUNT_EXTERNAL_DEFAULT |
| * @see com.android.internal.os.Zygote#MOUNT_EXTERNAL_READ |
| * @see com.android.internal.os.Zygote#MOUNT_EXTERNAL_WRITE |
| */ |
| public int getMountMode(int uid, String packageName); |
| |
| /** |
| * Gets whether external storage should be reported to the given UID. |
| * |
| * @param uid The UID for which to determine whether it has external storage. |
| * @param packageName The package in the UID for making the call. |
| * @return Weather to report external storage. |
| * @return True to report the state of external storage, false to |
| * report it as unmounted. |
| */ |
| public boolean hasExternalStorage(int uid, String packageName); |
| } |
| |
| /** |
| * Adds a policy for determining how external storage is mounted and reported. |
| * The mount mode is the most conservative result from querying all registered |
| * policies. Similarly, the reported state is the most conservative result from |
| * querying all registered policies. |
| * |
| * @param policy The policy to add. |
| */ |
| public abstract void addExternalStoragePolicy(ExternalStorageMountPolicy policy); |
| |
| /** |
| * Notify the mount service that the mount policy for a UID changed. |
| * @param uid The UID for which policy changed. |
| * @param packageName The package in the UID for making the call. |
| */ |
| public abstract void onExternalStoragePolicyChanged(int uid, String packageName); |
| |
| /** |
| * Gets the mount mode to use for a given UID as determined by consultin all |
| * policies. |
| * |
| * @param uid The UID for which to get mount mode. |
| * @param packageName The package in the UID for making the call. |
| * @return The mount mode. |
| */ |
| public abstract int getExternalStorageMountMode(int uid, String packageName); |
| |
| /** |
| * A listener for reset events in the StorageManagerService. |
| */ |
| public interface ResetListener { |
| /** |
| * A method that should be triggered internally by StorageManagerInternal |
| * when StorageManagerService reset happens. |
| * |
| * @param vold The binder object to vold. |
| */ |
| void onReset(IVold vold); |
| } |
| |
| /** |
| * Create storage directories if it does not exist. |
| * Return true if the directories were setup correctly, otherwise false. |
| */ |
| public abstract boolean prepareStorageDirs(int userId, Set<String> packageList, |
| String processName); |
| |
| /** |
| * Add a listener to listen to reset event in StorageManagerService. |
| * |
| * @param listener The listener that will be notified on reset events. |
| */ |
| public abstract void addResetListener(ResetListener listener); |
| |
| /** |
| * Notified when any app op changes so that storage mount points can be updated if the app op |
| * affects them. |
| */ |
| public abstract void onAppOpsChanged(int code, int uid, |
| @Nullable String packageName, int mode); |
| |
| /** |
| * Asks the StorageManager to reset all state for the provided user; this will result |
| * in the unmounting for all volumes of the user, and, if the user is still running, the |
| * volumes will be re-mounted as well. |
| * |
| * @param userId the userId for which to reset storage |
| */ |
| public abstract void resetUser(int userId); |
| |
| /** |
| * Returns {@code true} if the immediate last installed version of an app with {@code uid} had |
| * legacy storage, {@code false} otherwise. |
| */ |
| public abstract boolean hasLegacyExternalStorage(int uid); |
| |
| /** |
| * Makes sure app-private data directories on external storage are setup correctly |
| * after an application is installed or upgraded. The main use for this is OBB dirs, |
| * which can be created/modified by the installer. |
| * |
| * @param packageName the package name of the package |
| * @param uid the uid of the package |
| */ |
| public abstract void prepareAppDataAfterInstall(@NonNull String packageName, int uid); |
| |
| |
| /** |
| * Return true if uid is external storage service. |
| */ |
| public abstract boolean isExternalStorageService(int uid); |
| } |