1 /* 2 * Copyright 2009, The Android Open Source Project 3 * 4 * Licensed under the Apache License, Version 2.0 (the "License"); 5 * you may not use this file except in compliance with the License. 6 * You may obtain a copy of the License at 7 * 8 * http://www.apache.org/licenses/LICENSE-2.0 9 * 10 * Unless required by applicable law or agreed to in writing, software 11 * distributed under the License is distributed on an "AS IS" BASIS, 12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13 * See the License for the specific language governing permissions and 14 * limitations under the License. 15 */ 16 17 package android.app; 18 19 import android.app.backup.IBackupCallback; 20 import android.app.backup.IBackupManager; 21 import android.os.ParcelFileDescriptor; 22 23 /** 24 * Interface presented by applications being asked to participate in the 25 * backup & restore mechanism. End user code will not typically implement 26 * this interface directly; they subclass BackupAgent instead. 27 * 28 * {@hide} 29 */ 30 oneway interface IBackupAgent { 31 /** 32 * Request that the app perform an incremental backup. 33 * 34 * @param oldState Read-only file containing the description blob of the 35 * app's data state as of the last backup operation's completion. 36 * This file is empty or invalid when a full backup is being 37 * requested. 38 * 39 * @param data Read-write file, empty when onBackup() is called, that 40 * is the data destination for this backup pass's incrementals. 41 * 42 * @param newState Read-write file, empty when onBackup() is called, 43 * where the new state blob is to be recorded. 44 * 45 * @param quota Quota reported by the transport for this backup operation (in bytes). 46 * 47 * @param token Opaque token identifying this transaction. This must 48 * be echoed back to the backup service binder once the new 49 * data has been written to the data and newState files. 50 * 51 * @param callbackBinder Binder on which to indicate operation completion. 52 * 53 * @param transportFlags Flags with additional information about the transport. 54 */ doBackup(in ParcelFileDescriptor oldState, in ParcelFileDescriptor data, in ParcelFileDescriptor newState, long quotaBytes, IBackupCallback callbackBinder, int transportFlags)55 void doBackup(in ParcelFileDescriptor oldState, 56 in ParcelFileDescriptor data, 57 in ParcelFileDescriptor newState, 58 long quotaBytes, IBackupCallback callbackBinder, int transportFlags); 59 60 /** 61 * Restore an entire data snapshot to the application. 62 * 63 * @param data Read-only file containing the full data snapshot of the 64 * app's backup. This is to be a <i>replacement</i> of the app's 65 * current data, not to be merged into it. 66 * 67 * @param appVersionCode The android:versionCode attribute of the application 68 * that created this data set. This can help the agent distinguish among 69 * various historical backup content possibilities. 70 * 71 * @param newState Read-write file, empty when onRestore() is called, 72 * that is to be written with the state description that holds after 73 * the restore has been completed. 74 * 75 * @param token Opaque token identifying this transaction. This must 76 * be echoed back to the backup service binder once the agent is 77 * finished restoring the application based on the restore data 78 * contents. 79 * 80 * @param callbackBinder Binder on which to indicate operation completion, 81 * passed here as a convenience to the agent. 82 */ doRestore(in ParcelFileDescriptor data, long appVersionCode, in ParcelFileDescriptor newState, int token, IBackupManager callbackBinder)83 void doRestore(in ParcelFileDescriptor data, 84 long appVersionCode, in ParcelFileDescriptor newState, 85 int token, IBackupManager callbackBinder); 86 87 /** 88 * Restore an entire data snapshot to the application and pass the list of excluded keys to the 89 * backup agent. 90 * 91 * @param excludedKeys List of keys to be excluded from the restore. It will be passed to the 92 * backup agent to make it aware of what data has been removed (in case it has any 93 * application-level implications) as well as the data that should be removed by the 94 * agent itself. 95 */ doRestoreWithExcludedKeys(in ParcelFileDescriptor data, long appVersionCode, in ParcelFileDescriptor newState, int token, IBackupManager callbackBinder, in List<String> excludedKeys)96 void doRestoreWithExcludedKeys(in ParcelFileDescriptor data, 97 long appVersionCode, in ParcelFileDescriptor newState, 98 int token, IBackupManager callbackBinder, in List<String> excludedKeys); 99 100 /** 101 * Perform a "full" backup to the given file descriptor. The output file is presumed 102 * to be a socket or other non-seekable, write-only data sink. When this method is 103 * called, the app should write all of its files to the output. 104 * 105 * @param data Write-only file to receive the backed-up file content stream. 106 * The data must be formatted correctly for the resulting archive to be 107 * legitimate, so that will be tightly controlled by the available API. 108 * 109 * @param quota Quota reported by the transport for this backup operation (in bytes). 110 * 111 * @param token Opaque token identifying this transaction. This must 112 * be echoed back to the backup service binder once the agent is 113 * finished restoring the application based on the restore data 114 * contents. 115 * 116 * @param callbackBinder Binder on which to indicate operation completion, 117 * passed here as a convenience to the agent. 118 * 119 * @param transportFlags Flags with additional information about transport. 120 */ doFullBackup(in ParcelFileDescriptor data, long quotaBytes, int token, IBackupManager callbackBinder, int transportFlags)121 void doFullBackup(in ParcelFileDescriptor data, long quotaBytes, int token, 122 IBackupManager callbackBinder, int transportFlags); 123 124 /** 125 * Estimate how much data a full backup will deliver 126 */ doMeasureFullBackup(long quotaBytes, int token, IBackupManager callbackBinder, int transportFlags)127 void doMeasureFullBackup(long quotaBytes, int token, IBackupManager callbackBinder, 128 int transportFlags); 129 130 /** 131 * Tells the application agent that the backup data size exceeded current transport quota. 132 * Later calls to {@link #onBackup(ParcelFileDescriptor, BackupDataOutput, ParcelFileDescriptor)} 133 * and {@link #onFullBackup(FullBackupDataOutput)} could use this information 134 * to reduce backup size under the limit. 135 * However, the quota can change, so do not assume that the value passed in here is absolute, 136 * similarly all subsequent backups should not be restricted to this size. 137 * This callback will be invoked before data has been put onto the wire in a preflight check, 138 * so it is relatively inexpensive to hit your quota. 139 * Apps that hit quota repeatedly without dealing with it can be subject to having their backup 140 * schedule reduced. 141 * The {@code quotaBytes} is a loose guideline b/c of metadata added by the backupmanager 142 * so apps should be more aggressive in trimming their backup set. 143 * 144 * @param backupDataBytes Expected or already processed amount of data. 145 * Could be less than total backup size if backup process was interrupted 146 * before finish of processing all backup data. 147 * @param quotaBytes Current amount of backup data that is allowed for the app. 148 * @param callbackBinder Binder on which to indicate operation completion. 149 */ doQuotaExceeded(long backupDataBytes, long quotaBytes, IBackupCallback callbackBinder)150 void doQuotaExceeded(long backupDataBytes, long quotaBytes, IBackupCallback callbackBinder); 151 152 /** 153 * Restore a single "file" to the application. The file was typically obtained from 154 * a full-backup dataset. The agent reads 'size' bytes of file content 155 * from the provided file descriptor. 156 * 157 * @param data Read-only pipe delivering the file content itself. 158 * 159 * @param size Size of the file being restored. 160 * @param type Type of file system entity, e.g. FullBackup.TYPE_DIRECTORY. 161 * @param domain Name of the file's semantic domain to which the 'path' argument is a 162 * relative path. e.g. FullBackup.DATABASE_TREE_TOKEN. 163 * @param path Relative path of the file within its semantic domain. 164 * @param mode Access mode of the file system entity, e.g. 0660. 165 * @param mtime Last modification time of the file system entity. 166 * @param token Opaque token identifying this transaction. This must 167 * be echoed back to the backup service binder once the agent is 168 * finished restoring the application based on the restore data 169 * contents. 170 * @param callbackBinder Binder on which to indicate operation completion, 171 * passed here as a convenience to the agent. 172 */ doRestoreFile(in ParcelFileDescriptor data, long size, int type, String domain, String path, long mode, long mtime, int token, IBackupManager callbackBinder)173 void doRestoreFile(in ParcelFileDescriptor data, long size, 174 int type, String domain, String path, long mode, long mtime, 175 int token, IBackupManager callbackBinder); 176 177 /** 178 * Provide the app with a canonical "all data has been delivered" end-of-restore 179 * callback so that it can do any postprocessing of the restored data that might 180 * be appropriate. This is issued after both key/value and full data restore 181 * operations have completed. 182 * 183 * @param token Opaque token identifying this transaction. This must 184 * be echoed back to the backup service binder once the agent is 185 * finished restoring the application based on the restore data 186 * contents. 187 * @param callbackBinder Binder on which to indicate operation completion, 188 * passed here as a convenience to the agent. 189 */ doRestoreFinished(int token, IBackupManager callbackBinder)190 void doRestoreFinished(int token, IBackupManager callbackBinder); 191 192 /** 193 * Out of band: instruct the agent to crash within the client process. This is used 194 * when the backup infrastructure detects a semantic error post-hoc and needs to 195 * pass the problem back to the app. 196 * 197 * @param message The message to be passed to the agent's application in an exception. 198 */ fail(String message)199 void fail(String message); 200 } 201