317 lines
14 KiB
Java
317 lines
14 KiB
Java
|
/*
|
||
|
|
* Copyright (C) 2017 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.app.backup;
|
||
|
|
|
||
|
|
import android.annotation.SystemApi;
|
||
|
|
import android.app.backup.BackupAnnotations.OperationType;
|
||
|
|
import android.content.pm.PackageInfo;
|
||
|
|
import android.os.Bundle;
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Callback class for receiving important events during backup/restore operations.
|
||
|
|
* Events consist mostly of errors and exceptions, giving detailed reason on why a restore/backup
|
||
|
|
* failed or any time BackupManager makes an important decision.
|
||
|
|
* On the other hand {@link BackupObserver} will give a failure/success view without
|
||
|
|
* getting into details why. This callback runs on the thread it was called on because it can get
|
||
|
|
* a bit spammy.
|
||
|
|
* These callbacks will run on the binder thread.
|
||
|
|
*
|
||
|
|
* @hide
|
||
|
|
*/
|
||
|
|
@SystemApi
|
||
|
|
public class BackupManagerMonitor {
|
||
|
|
|
||
|
|
// Logging constants for BackupManagerMonitor
|
||
|
|
public static final int LOG_EVENT_CATEGORY_TRANSPORT = 1;
|
||
|
|
public static final int LOG_EVENT_CATEGORY_AGENT = 2;
|
||
|
|
public static final int LOG_EVENT_CATEGORY_BACKUP_MANAGER_POLICY = 3;
|
||
|
|
/** string : the package name */
|
||
|
|
public static final String EXTRA_LOG_EVENT_PACKAGE_NAME =
|
||
|
|
"android.app.backup.extra.LOG_EVENT_PACKAGE_NAME";
|
||
|
|
/** int : the versionCode of the package named by EXTRA_LOG_EVENT_PACKAGE_NAME
|
||
|
|
* @deprecated Use {@link #EXTRA_LOG_EVENT_PACKAGE_LONG_VERSION} */
|
||
|
|
@Deprecated
|
||
|
|
public static final String EXTRA_LOG_EVENT_PACKAGE_VERSION =
|
||
|
|
"android.app.backup.extra.LOG_EVENT_PACKAGE_VERSION";
|
||
|
|
/** long : the full versionCode of the package named by EXTRA_LOG_EVENT_PACKAGE_NAME */
|
||
|
|
public static final String EXTRA_LOG_EVENT_PACKAGE_LONG_VERSION =
|
||
|
|
"android.app.backup.extra.LOG_EVENT_PACKAGE_FULL_VERSION";
|
||
|
|
/** int : the id of the log message, will be a unique identifier */
|
||
|
|
public static final String EXTRA_LOG_EVENT_ID = "android.app.backup.extra.LOG_EVENT_ID";
|
||
|
|
/**
|
||
|
|
* int : category will be one of
|
||
|
|
* { LOG_EVENT_CATEGORY_TRANSPORT,
|
||
|
|
* LOG_EVENT_CATEGORY_AGENT,
|
||
|
|
* LOG_EVENT_CATEGORY_BACKUP_MANAGER_POLICY}.
|
||
|
|
*/
|
||
|
|
public static final String EXTRA_LOG_EVENT_CATEGORY =
|
||
|
|
"android.app.backup.extra.LOG_EVENT_CATEGORY";
|
||
|
|
|
||
|
|
|
||
|
|
/**
|
||
|
|
* boolean: when we have an event with id LOG_EVENT_ID_KEY_VALUE_BACKUP_CANCEL we record if
|
||
|
|
* the call was to cancel backup of all packages
|
||
|
|
*/
|
||
|
|
public static final String EXTRA_LOG_CANCEL_ALL = "android.app.backup.extra.LOG_CANCEL_ALL";
|
||
|
|
|
||
|
|
/**
|
||
|
|
* string: when we have an event with id LOG_EVENT_ID_ILLEGAL_KEY we send the key that was used
|
||
|
|
* by the app
|
||
|
|
*/
|
||
|
|
public static final String EXTRA_LOG_ILLEGAL_KEY = "android.app.backup.extra.LOG_ILLEGAL_KEY";
|
||
|
|
|
||
|
|
/**
|
||
|
|
* long: when we have an event with id LOG_EVENT_ID_ERROR_PREFLIGHT we send the error code that
|
||
|
|
* was returned by the transport during preflight
|
||
|
|
*/
|
||
|
|
public static final String EXTRA_LOG_PREFLIGHT_ERROR =
|
||
|
|
"android.app.backup.extra.LOG_PREFLIGHT_ERROR";
|
||
|
|
|
||
|
|
/**
|
||
|
|
* string: when we have an event with id LOG_EVENT_ID_EXCEPTION_FULL_BACKUP we send the
|
||
|
|
* exception's stacktrace
|
||
|
|
*/
|
||
|
|
public static final String EXTRA_LOG_EXCEPTION_FULL_BACKUP =
|
||
|
|
"android.app.backup.extra.LOG_EXCEPTION_FULL_BACKUP";
|
||
|
|
|
||
|
|
/**
|
||
|
|
* int: when we have an event with id LOG_EVENT_ID_RESTORE_VERSION_HIGHER we send the
|
||
|
|
* restore package version
|
||
|
|
*/
|
||
|
|
public static final String EXTRA_LOG_RESTORE_VERSION =
|
||
|
|
"android.app.backup.extra.LOG_RESTORE_VERSION";
|
||
|
|
|
||
|
|
/**
|
||
|
|
* boolean: when we have an event with id LOG_EVENT_ID_RESTORE_VERSION_HIGHER we record if
|
||
|
|
* ApplicationInfo.FLAG_RESTORE_ANY_VERSION flag is set
|
||
|
|
*/
|
||
|
|
public static final String EXTRA_LOG_RESTORE_ANYWAY =
|
||
|
|
"android.app.backup.extra.LOG_RESTORE_ANYWAY";
|
||
|
|
|
||
|
|
|
||
|
|
/**
|
||
|
|
* boolean: when we have an event with id LOG_EVENT_ID_APK_NOT_INSTALLED we record if
|
||
|
|
* the policy allows to install apks provided with the dataset
|
||
|
|
*/
|
||
|
|
public static final String EXTRA_LOG_POLICY_ALLOW_APKS =
|
||
|
|
"android.app.backup.extra.LOG_POLICY_ALLOW_APKS";
|
||
|
|
|
||
|
|
|
||
|
|
/**
|
||
|
|
* string: when we have an event with id LOG_EVENT_ID_EXPECTED_DIFFERENT_PACKAGE we record the
|
||
|
|
* package name provided in the restore manifest
|
||
|
|
*/
|
||
|
|
public static final String EXTRA_LOG_MANIFEST_PACKAGE_NAME =
|
||
|
|
"android.app.backup.extra.LOG_MANIFEST_PACKAGE_NAME";
|
||
|
|
|
||
|
|
/**
|
||
|
|
* string: when we have an event with id LOG_EVENT_ID_WIDGET_METADATA_MISMATCH we record the
|
||
|
|
* package name provided in the widget metadata
|
||
|
|
*/
|
||
|
|
public static final String EXTRA_LOG_WIDGET_PACKAGE_NAME =
|
||
|
|
"android.app.backup.extra.LOG_WIDGET_PACKAGE_NAME";
|
||
|
|
|
||
|
|
/**
|
||
|
|
* int: when we have event of id LOG_EVENT_ID_VERSION_OF_BACKUP_OLDER we send the version
|
||
|
|
* of the backup.
|
||
|
|
*/
|
||
|
|
public static final String EXTRA_LOG_OLD_VERSION = "android.app.backup.extra.LOG_OLD_VERSION";
|
||
|
|
|
||
|
|
/**
|
||
|
|
* ParcelableList: when we have an event of id LOG_EVENT_ID_AGENT_LOGGING_RESULTS we send a list
|
||
|
|
* of {@link android.app.backup.BackupRestoreEventLogger.DataTypeResult}.
|
||
|
|
*/
|
||
|
|
public static final String EXTRA_LOG_AGENT_LOGGING_RESULTS =
|
||
|
|
"android.app.backup.extra.LOG_AGENT_LOGGING_RESULTS";
|
||
|
|
|
||
|
|
/**
|
||
|
|
* The operation type this log is associated with. See {@link OperationType}.
|
||
|
|
*
|
||
|
|
* @hide
|
||
|
|
*/
|
||
|
|
public static final String EXTRA_LOG_OPERATION_TYPE = "android.app.backup.extra.OPERATION_TYPE";
|
||
|
|
|
||
|
|
/**
|
||
|
|
* List of system components that do not support restore in a V-> U OS downgrade, even if
|
||
|
|
* restoreAnyVersion is set to true.
|
||
|
|
* Read from Settings.Secure.V_TO_U_RESTORE_DENYLIST
|
||
|
|
*
|
||
|
|
* @hide
|
||
|
|
*/
|
||
|
|
public static final String EXTRA_LOG_V_TO_U_DENYLIST = "android.app.backup.extra.V_TO_U_DENYLIST";
|
||
|
|
|
||
|
|
/**
|
||
|
|
* List of system components that support restore in a V-> U OS downgrade, even if
|
||
|
|
* restoreAnyVersion is set to false.
|
||
|
|
* Read from Settings.Secure.V_TO_U_RESTORE_ALLOWLIST
|
||
|
|
*
|
||
|
|
* @hide
|
||
|
|
*/
|
||
|
|
public static final String EXTRA_LOG_V_TO_U_ALLOWLIST =
|
||
|
|
"android.app.backup.extra.V_TO_U_ALLOWLIST";
|
||
|
|
|
||
|
|
// TODO complete this list with all log messages. And document properly.
|
||
|
|
public static final int LOG_EVENT_ID_FULL_BACKUP_CANCEL = 4;
|
||
|
|
public static final int LOG_EVENT_ID_ILLEGAL_KEY = 5;
|
||
|
|
public static final int LOG_EVENT_ID_NO_DATA_TO_SEND = 7;
|
||
|
|
public static final int LOG_EVENT_ID_PACKAGE_INELIGIBLE = 9;
|
||
|
|
public static final int LOG_EVENT_ID_PACKAGE_KEY_VALUE_PARTICIPANT = 10;
|
||
|
|
public static final int LOG_EVENT_ID_PACKAGE_STOPPED = 11;
|
||
|
|
public static final int LOG_EVENT_ID_PACKAGE_NOT_FOUND = 12;
|
||
|
|
public static final int LOG_EVENT_ID_BACKUP_DISABLED = 13;
|
||
|
|
public static final int LOG_EVENT_ID_DEVICE_NOT_PROVISIONED = 14;
|
||
|
|
public static final int LOG_EVENT_ID_PACKAGE_TRANSPORT_NOT_PRESENT = 15;
|
||
|
|
public static final int LOG_EVENT_ID_ERROR_PREFLIGHT = 16;
|
||
|
|
public static final int LOG_EVENT_ID_QUOTA_HIT_PREFLIGHT = 18;
|
||
|
|
public static final int LOG_EVENT_ID_EXCEPTION_FULL_BACKUP = 19;
|
||
|
|
public static final int LOG_EVENT_ID_KEY_VALUE_BACKUP_CANCEL = 21;
|
||
|
|
public static final int LOG_EVENT_ID_NO_RESTORE_METADATA_AVAILABLE = 22;
|
||
|
|
public static final int LOG_EVENT_ID_NO_PM_METADATA_RECEIVED = 23;
|
||
|
|
public static final int LOG_EVENT_ID_PM_AGENT_HAS_NO_METADATA = 24;
|
||
|
|
public static final int LOG_EVENT_ID_LOST_TRANSPORT = 25;
|
||
|
|
public static final int LOG_EVENT_ID_PACKAGE_NOT_PRESENT = 26;
|
||
|
|
public static final int LOG_EVENT_ID_RESTORE_VERSION_HIGHER = 27;
|
||
|
|
public static final int LOG_EVENT_ID_APP_HAS_NO_AGENT = 28;
|
||
|
|
public static final int LOG_EVENT_ID_SIGNATURE_MISMATCH = 29;
|
||
|
|
public static final int LOG_EVENT_ID_CANT_FIND_AGENT = 30;
|
||
|
|
public static final int LOG_EVENT_ID_KEY_VALUE_RESTORE_TIMEOUT = 31;
|
||
|
|
public static final int LOG_EVENT_ID_RESTORE_ANY_VERSION = 34;
|
||
|
|
public static final int LOG_EVENT_ID_VERSIONS_MATCH = 35;
|
||
|
|
public static final int LOG_EVENT_ID_VERSION_OF_BACKUP_OLDER = 36;
|
||
|
|
public static final int LOG_EVENT_ID_FULL_RESTORE_SIGNATURE_MISMATCH = 37;
|
||
|
|
public static final int LOG_EVENT_ID_SYSTEM_APP_NO_AGENT = 38;
|
||
|
|
public static final int LOG_EVENT_ID_FULL_RESTORE_ALLOW_BACKUP_FALSE = 39;
|
||
|
|
public static final int LOG_EVENT_ID_APK_NOT_INSTALLED = 40;
|
||
|
|
public static final int LOG_EVENT_ID_CANNOT_RESTORE_WITHOUT_APK = 41;
|
||
|
|
public static final int LOG_EVENT_ID_MISSING_SIGNATURE = 42;
|
||
|
|
public static final int LOG_EVENT_ID_EXPECTED_DIFFERENT_PACKAGE = 43;
|
||
|
|
public static final int LOG_EVENT_ID_UNKNOWN_VERSION = 44;
|
||
|
|
public static final int LOG_EVENT_ID_FULL_RESTORE_TIMEOUT = 45;
|
||
|
|
public static final int LOG_EVENT_ID_CORRUPT_MANIFEST = 46;
|
||
|
|
public static final int LOG_EVENT_ID_WIDGET_METADATA_MISMATCH = 47;
|
||
|
|
public static final int LOG_EVENT_ID_WIDGET_UNKNOWN_VERSION = 48;
|
||
|
|
public static final int LOG_EVENT_ID_NO_PACKAGES = 49;
|
||
|
|
public static final int LOG_EVENT_ID_TRANSPORT_IS_NULL = 50;
|
||
|
|
/** The transport returned {@link BackupTransport#TRANSPORT_NON_INCREMENTAL_BACKUP_REQUIRED}. */
|
||
|
|
public static final int LOG_EVENT_ID_TRANSPORT_NON_INCREMENTAL_BACKUP_REQUIRED = 51;
|
||
|
|
|
||
|
|
public static final int LOG_EVENT_ID_AGENT_LOGGING_RESULTS = 52;
|
||
|
|
/** @hide */
|
||
|
|
public static final int LOG_EVENT_ID_START_SYSTEM_RESTORE = 53;
|
||
|
|
/** @hide */
|
||
|
|
public static final int LOG_EVENT_ID_START_RESTORE_AT_INSTALL = 54;
|
||
|
|
/** A transport error happened during {@link PerformUnifiedRestoreTask#startRestore()}
|
||
|
|
@hide */
|
||
|
|
public static final int LOG_EVENT_ID_TRANSPORT_ERROR_DURING_START_RESTORE = 55;
|
||
|
|
/** Unable to get the name of the next package in the queue during a restore operation
|
||
|
|
@hide */
|
||
|
|
public static final int LOG_EVENT_ID_CANNOT_GET_NEXT_PKG_NAME = 56;
|
||
|
|
/** Attempting a restore operation that is neither KV nor full
|
||
|
|
@hide */
|
||
|
|
public static final int LOG_EVENT_ID_UNKNOWN_RESTORE_TYPE = 57;
|
||
|
|
/** The package is part of KeyValue restore
|
||
|
|
@hide */
|
||
|
|
public static final int LOG_EVENT_ID_KV_RESTORE = 58;
|
||
|
|
/** The package is part of Full restore
|
||
|
|
@hide */
|
||
|
|
public static final int LOG_EVENT_ID_FULL_RESTORE = 59;
|
||
|
|
/** Unable to fetch the nest restore target in the queue
|
||
|
|
@hide */
|
||
|
|
public static final int LOG_EVENT_ID_NO_NEXT_RESTORE_TARGET = 60;
|
||
|
|
/** An error occurred while attempting KeyValueRestore
|
||
|
|
@hide */
|
||
|
|
public static final int LOG_EVENT_ID_KV_AGENT_ERROR = 61;
|
||
|
|
/** Restore operation finished for the given package
|
||
|
|
@hide */
|
||
|
|
public static final int LOG_EVENT_ID_PACKAGE_RESTORE_FINISHED= 62;
|
||
|
|
/** A transport error happened during
|
||
|
|
* {@link PerformUnifiedRestoreTask#initiateOneRestore(PackageInfo, long)}
|
||
|
|
@hide */
|
||
|
|
public static final int LOG_EVENT_ID_TRANSPORT_ERROR_KV_RESTORE = 63;
|
||
|
|
/** Unable to instantiate the feeder thread in full restore
|
||
|
|
@hide */
|
||
|
|
public static final int LOG_EVENT_ID_NO_FEEDER_THREAD = 64;
|
||
|
|
/** An error occurred while attempting Full restore
|
||
|
|
@hide */
|
||
|
|
public static final int LOG_EVENT_ID_FULL_AGENT_ERROR = 65;
|
||
|
|
/** A transport error happened during a full restore
|
||
|
|
@hide */
|
||
|
|
public static final int LOG_EVENT_ID_TRANSPORT_ERROR_FULL_RESTORE = 66;
|
||
|
|
/** Start restore operation for a given package
|
||
|
|
@hide */
|
||
|
|
public static final int LOG_EVENT_ID_START_PACKAGE_RESTORE = 67;
|
||
|
|
/** Whole restore operation is complete
|
||
|
|
@hide */
|
||
|
|
public static final int LOG_EVENT_ID_RESTORE_COMPLETE = 68;
|
||
|
|
/** Agent error during {@link PerformUnifiedRestoreTask#restoreFinished()}
|
||
|
|
@hide */
|
||
|
|
public static final int LOG_EVENT_ID_AGENT_FAILURE = 69;
|
||
|
|
/** V to U restore attempt, pkg is eligible
|
||
|
|
@hide */
|
||
|
|
public static final int LOG_EVENT_ID_V_TO_U_RESTORE_PKG_ELIGIBLE = 70;
|
||
|
|
/** V to U restore attempt, pkg is not eligible
|
||
|
|
@hide */
|
||
|
|
public static final int LOG_EVENT_ID_V_TO_U_RESTORE_PKG_NOT_ELIGIBLE = 71;
|
||
|
|
/** V to U restore attempt, allowlist and denlist are set
|
||
|
|
@hide */
|
||
|
|
public static final int LOG_EVENT_ID_V_TO_U_RESTORE_SET_LIST = 72;
|
||
|
|
/** As part of package install, {@link PackageManager} invoked restore.
|
||
|
|
@hide */
|
||
|
|
public static final int LOG_EVENT_ID_RESTORE_AT_INSTALL_INVOKED = 73;
|
||
|
|
/** Skipping restore at package install
|
||
|
|
@hide */
|
||
|
|
public static final int LOG_EVENT_ID_SKIP_RESTORE_AT_INSTALL = 74;
|
||
|
|
/** Package is eligible and is accepted for restore
|
||
|
|
@hide */
|
||
|
|
public static final int LOG_EVENT_ID_PACKAGE_ACCEPTED_FOR_RESTORE = 75;
|
||
|
|
/** Restore data doesn't belong to the package for which restore is started
|
||
|
|
@hide */
|
||
|
|
public static final int LOG_EVENT_ID_RESTORE_DATA_DOES_NOT_BELONG_TO_PACKAGE = 76;
|
||
|
|
/** Unable to create BackupAgent for package for restore
|
||
|
|
@hide */
|
||
|
|
public static final int LOG_EVENT_ID_UNABLE_TO_CREATE_AGENT_FOR_RESTORE = 77;
|
||
|
|
/** BackupAgent crashed after creation but before accepting any data
|
||
|
|
@hide */
|
||
|
|
public static final int LOG_EVENT_ID_AGENT_CRASHED_BEFORE_RESTORE_DATA_IS_SENT = 78;
|
||
|
|
/** Failure in streaming restore data to BackupAgent
|
||
|
|
@hide */
|
||
|
|
public static final int LOG_EVENT_ID_FAILED_TO_SEND_DATA_TO_AGENT_DURING_RESTORE = 79;
|
||
|
|
/** BackupAgent related failure during restore
|
||
|
|
@hide */
|
||
|
|
public static final int LOG_EVENT_ID_AGENT_FAILURE_DURING_RESTORE = 80;
|
||
|
|
/** Failure in reading data from TransportPackage during restore
|
||
|
|
@hide */
|
||
|
|
public static final int LOG_EVENT_ID_FAILED_TO_READ_DATA_FROM_TRANSPORT = 81;
|
||
|
|
|
||
|
|
/**
|
||
|
|
* This method will be called each time something important happens on BackupManager.
|
||
|
|
*
|
||
|
|
* @param event bundle will contain data about event:
|
||
|
|
* - event id, not optional, a unique identifier for each event.
|
||
|
|
* - package name, optional, the current package we're backing up/restoring if applicable.
|
||
|
|
* - package version, optional, the current package version we're backing up/restoring
|
||
|
|
* if applicable.
|
||
|
|
* - category of event, not optional, one of
|
||
|
|
* { LOG_EVENT_CATEGORY_TRANSPORT,
|
||
|
|
* LOG_EVENT_CATEGORY_AGENT,
|
||
|
|
* LOG_EVENT_CATEGORY_BACKUP_MANAGER_POLICY}
|
||
|
|
*
|
||
|
|
*/
|
||
|
|
public void onEvent(Bundle event) {
|
||
|
|
}
|
||
|
|
}
|