core/java/com/android/internal/backup/IBackupTransport.aidl

/*
 * Copyright (C) 2009 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.internal.backup;

import android.app.backup.IBackupManagerMonitor;
import android.app.backup.RestoreDescription;
import android.app.backup.RestoreSet;
import android.content.Intent;
import android.content.pm.PackageInfo;
import android.os.ParcelFileDescriptor;

import com.android.internal.backup.ITransportStatusCallback;
import com.android.internal.infra.AndroidFuture;

/** {@hide} */
oneway interface IBackupTransport {
    /**
     * Ask the transport for the String name under which it should be registered.  This will
     * typically be its host service's component name, but need not be.
     *
     * @param resultFuture an {@link AndroidFuture} that is completed with the {@code String} name
     * of the transport.
     */
    void name(in AndroidFuture<String> result);

    /**
     * Ask the transport for an Intent that can be used to launch any internal
     * configuration Activity that it wishes to present.  For example, the transport
     * may offer a UI for allowing the user to supply login credentials for the
     * transport's off-device backend.
     *
     * If the transport does not supply any user-facing configuration UI, it should
     * return null from this method.
     *
     * @param resultFuture an {@link AndroidFuture} that is completed with an {@code Intent} that
     *        can be passed to Context.startActivity() in order to launch the transport's
     *        configuration UI.  This future will complete with null if the transport does not
     *        offer any user-facing configuration UI.
     */
    void configurationIntent(in AndroidFuture<Intent> resultFuture);

    /**
     * Ask the transport for a one-line string that can be shown to the user that
     * describes the current backend destination.  For example, a transport that
     * can potentially associate backup data with arbitrary user accounts should
     * include the name of the currently-active account here.
     *
     * @param resultFuture an {@link AndroidFuture} that is completed with a {@code String}
     *        describing the destination to which the transport is currently sending data.
     */
    void currentDestinationString(in AndroidFuture<String> resultFuture);

    /**
     * Ask the transport for an Intent that can be used to launch a more detailed
     * secondary data management activity.  For example, the configuration intent might
     * be one for allowing the user to select which account they wish to associate
     * their backups with, and the management intent might be one which presents a
     * UI for managing the data on the backend.
     *
     * <p>In the Settings UI, the configuration intent will typically be invoked
     * when the user taps on the preferences item labeled with the current
     * destination string, and the management intent will be placed in an overflow
     * menu labelled with the management label string.
     *
     * <p>If the transport does not supply any user-facing data management
     * UI, then it should return {@code null} from this method.
     *
     * @param resultFuture an {@link AndroidFuture} that is completed with an {@code Intent} that
     *        can be passed to Context.startActivity() in order to launch the transport's
     *        data-management UI. The callback will supply {@code null} if the transport does not
     *        offer any user-facing data management UI.
     */
    void dataManagementIntent(in AndroidFuture<Intent> resultFuture);

    /**
     * Ask the transport for a short {@link CharSequence} that can be shown to the user as the label
     * on an overflow menu item used to invoke the data management UI.
     *
     * @param resultFuture an {@link AndroidFuture} that is completed with a {@code CharSequence}
     *        to be used as the label for the transport's data management affordance.  If the
     *        transport supplies a data management Intent via {@link #dataManagementIntent},
     *        this method must not return {@code null}.
     */
    void dataManagementIntentLabel(in AndroidFuture<CharSequence> resultFuture);

    /**
     * Ask the transport where, on local device storage, to keep backup state blobs.
     * This is per-transport so that mock transports used for testing can coexist with
     * "live" backup services without interfering with the live bookkeeping.  The
     * returned string should be a name that is expected to be unambiguous among all
     * available backup transports; the name of the class implementing the transport
     * is a good choice.  This MUST be constant.
     *
     * @param resultFuture an {@link AndroidFuture} that is completed with a unique {@code String}
     *        name, suitable for use as a file or directory name, that the Backup Manager could use
     *        to disambiguate state files associated with different backup transports.
     */
    void transportDirName(in AndroidFuture<String> resultFuture);

    /**
     * Verify that this is a suitable time for a backup pass.  This should return zero
     * if a backup is reasonable right now, some positive value otherwise.  This method
     * will be called outside of the {@link #startSession}/{@link #endSession} pair.
     *
     * <p>If this is not a suitable time for a backup, the transport should return a
     * backoff delay, in milliseconds, after which the Backup Manager should try again.
     *
     * @param resultFuture an {@link AndroidFuture} that is completed with {@code int}: zero if
     *        this is a suitable time for a backup pass, or a positive time delay in milliseconds
     *        to suggest deferring the backup pass for a while.
     */
    void requestBackupTime(in AndroidFuture<long> resultFuture);

    /**
     * Initialize the server side storage for this device, erasing all stored data.
     * The transport may send the request immediately, or may buffer it.  After
     * this is called, {@link #finishBackup} must be called to ensure the request
     * is sent and received successfully.
     *
     * @param callback a callback that is completed with a {@code int} which is one
     *        of {@link BackupConstants#TRANSPORT_OK} (OK so far) or
     *        {@link BackupConstants#TRANSPORT_ERROR} (on network error or other failure).
     */
    void initializeDevice(in ITransportStatusCallback callback);

    /**
     * Send one application's data to the backup destination.  The transport may send
     * the data immediately, or may buffer it.  After this is called, {@link #finishBackup}
     * must be called to ensure the data is sent and recorded successfully.
     *
     * @param packageInfo The identity of the application whose data is being backed up.
     *   This specifically includes the signature list for the package.
     * @param inFd Descriptor of file with data that resulted from invoking the application's
     *   BackupService.doBackup() method.  This may be a pipe rather than a file on
     *   persistent media, so it may not be seekable.
     * @param flags Some of {@link BackupTransport#FLAG_USER_INITIATED}.
     * @param callback a callback that is completed with a {@code int} which is one
     *  of {@link BackupConstants#TRANSPORT_OK}(OK so far), {@link BackupConstants#TRANSPORT_ERROR}
     *  (on network error or other failure), or {@link BackupConstants#TRANSPORT_NOT_INITIALIZED}
     *  (if the backend dataset has become lost due to inactive expiry or some other reason and
     *  needs re-initializing).
     */
    void performBackup(in PackageInfo packageInfo, in ParcelFileDescriptor inFd, int flags,
            in ITransportStatusCallback callback);

    /**
     * Erase the give application's data from the backup destination.  This clears
     * out the given package's data from the current backup set, making it as though
     * the app had never yet been backed up.  After this is called, {@link finishBackup}
     * must be called to ensure that the operation is recorded successfully.
     *
     * @param callback a callback that is completed with the same error codes as
     *        {@link #performBackup}.
     */
    void clearBackupData(in PackageInfo packageInfo, in ITransportStatusCallback callback);

    /**
     * Finish sending application data to the backup destination.  This must be
     * called after {@link #performBackup} or {@link clearBackupData} to ensure that
     * all data is sent.  Only when this method returns true can a backup be assumed
     * to have succeeded.
     *
     * @param callback a callback that is completed with the same error codes as
     *        {@link #performBackup}.
     */
    void finishBackup(in ITransportStatusCallback callback);

    /**
     * Get the set of all backups currently available over this transport.
     *
     * @param resultFuture an {@link AndroidFuture} that is completed with {@code List<RestoreSet>}:
     *        the descriptions of a set of restore images available for this device, or null if an
     *        error occurred (the attempt should be rescheduled).
     **/
    void getAvailableRestoreSets(in AndroidFuture<List<RestoreSet>> resultFuture);

    /**
     * Get the identifying token of the backup set currently being stored from
     * this device.  This is used in the case of applications wishing to restore
     * their last-known-good data.
     *
     * @param resultFuture an {@link AndroidFuture} that is completed with a {@code long}: a token
     *        that can be passed to {@link #startRestore}, or 0 if there is no backup set available
     *        corresponding to the current device state.
     */
    void getCurrentRestoreSet(in AndroidFuture<long> resultFuture);

    /**
     * Start restoring application data from backup.  After calling this function,
     * alternate calls to {@link #nextRestorePackage} and {@link #nextRestoreData}
     * to walk through the actual application data.
     *
     * @param token A backup token as returned by {@link #getAvailableRestoreSets}
     *   or {@link #getCurrentRestoreSet}.
     * @param packages List of applications to restore (if data is available).
     *   Application data will be restored in the order given.
     * @param callback a callback that is completed with one of
     *   {@link BackupConstants#TRANSPORT_OK} (OK so far, call {@link #nextRestorePackage}) or
     *   {@link BackupConstants#TRANSPORT_ERROR} (an error occurred, the restore should be aborted
     *   and rescheduled).
     */
    void startRestore(long token, in PackageInfo[] packages, in ITransportStatusCallback callback);

    /**
     * Get the package name of the next application with data in the backup store, plus
     * a description of the structure of the restored archive: either TYPE_KEY_VALUE for
     * an original-API key/value dataset, or TYPE_FULL_STREAM for a tarball-type archive stream.
     *
     * <p>If the package name in the returned RestoreDescription object is the singleton
     * {@link RestoreDescription#NO_MORE_PACKAGES}, it indicates that no further data is available
     * in the current restore session: all packages described in startRestore() have been
     * processed.
     *
     * <p>If this method returns {@code null}, it means that a transport-level error has
     * occurred and the entire restore operation should be abandoned.
     *
     * @param resultFuture an {@link AndroidFuture} that is completed with a
     *   {@link RestoreDescription} object containing the name of one of the packages supplied to
     *   {@link #startRestore} plus an indicator of the data type of that restore data; or
     *   {@link RestoreDescription#NO_MORE_PACKAGES} to indicate that no more packages can be
     *   restored in this session; or {@code null} to indicate a transport-level error.
     */
    void nextRestorePackage(in AndroidFuture<RestoreDescription> resultFuture);

    /**
     * Get the data for the application returned by {@link #nextRestorePackage}.
     * @param data An open, writable file into which the backup data should be stored.
     *
     * @param callback a callback that is completed with the same error codes as
     *        {@link #startRestore}.
     */
    void getRestoreData(in ParcelFileDescriptor outFd, in ITransportStatusCallback callback);

    /**
     * End a restore session (aborting any in-process data transfer as necessary),
     * freeing any resources and connections used during the restore process.
     *
     * @param callback a callback to signal that restore has been finished on transport side.
     */
    void finishRestore(in ITransportStatusCallback callback);

    // full backup stuff

    /**
     * Verify that this is a suitable time for a full-data backup pass.
     *
     * @param resultFuture an {@link AndroidFuture} that is completed with {@code long}: 0 if this
     *        is a suitable time for a backup pass, or a positive time delay in milliseconds to
     *        suggest deferring the backup pass for a while.
     */
    void requestFullBackupTime(in AndroidFuture<long> resultFuture);

    /**
     * Begin the process of sending an application's full-data archive to the backend.
     *
     * @param targetPackage The package whose data is to follow.
     * @param socket The socket file descriptor through which the data will be provided.
     * @param flags {@link BackupTransport#FLAG_USER_INITIATED} or 0.
     * @param callback callback to return a {@code int} which is one of:
     *        {@link BackupTransport#TRANSPORT_PACKAGE_REJECTED} to indicate that the stated
     *        application is not to be backed up; {@link BackupTransport#TRANSPORT_OK} to indicate
     *        that the OS may proceed with delivering backup data;
     *        {@link BackupTransport#TRANSPORT_ERROR to indicate a fatal error condition that
     *        precludes performing a backup at this time.
     */
    void performFullBackup(in PackageInfo targetPackage, in ParcelFileDescriptor socket, int flags,
            in ITransportStatusCallback callback);

    /**
     * Called after {@link #performFullBackup} to make sure that the transport is willing to
     * handle a full-data backup operation of the specified size on the current package.
     *
     * @param size The estimated size of the full-data payload for this app.  This includes
     *         manifest and archive format overhead, but is not guaranteed to be precise.
     * @param callback a callback that is completed with a {@code int} which is
     *        one of: {@link BackupTransport#TRANSPORT_OK} if the platform is to proceed with the
     *        full-data {@link BackupTransport#TRANSPORT_PACKAGE_REJECTED} if the proposed payload
     *        size is backup, too large for the transport to handle, or
     *        {@link BackupTransport#TRANSPORT_ERROR} to indicate a fatal error condition that
     *        means the platform cannot perform a backup at this time.
     */
    void checkFullBackupSize(long size, in ITransportStatusCallback callback);

    /**
     * Tells the transport to read {@code numBytes} bytes of data from the socket file
     * descriptor provided in the {@link #performFullBackup(PackageInfo, ParcelFileDescriptor)}
     * call, and deliver those bytes to the datastore.
     *
     * @param numBytes The number of bytes of tarball data available to be read from the
     *    socket.
     * @param callback a callback that is completed with a {@code int} which is
     *        one of: {@link BackupTransport#TRANSPORT_OK} on successful processing of the data,
     *        {@link BackupTransport#TRANSPORT_ERROR} to indicate a fatal error situation.  If an
     *        error is returned, the system will call finishBackup() and stop attempting backups
     *        until after a backoff and retry interval.
     */
    void sendBackupData(int numBytes, in ITransportStatusCallback callback);

    /**
     * Tells the transport to cancel the currently-ongoing full backup operation.
     *
     * @param callback a callback to indicate that transport has cancelled the operation,
     *        does not return any value (see {@link ITransportCallback#onVoidReceived}).
     */
    void cancelFullBackup(in ITransportStatusCallback callback);

    /**
     * Ask the transport whether this app is eligible for backup.
     *
     * @param targetPackage The identity of the application.
     * @param isFullBackup If set, transport should check if app is eligible for full data backup,
     *   otherwise to check if eligible for key-value backup.
     * @param resultFuture an {@link AndroidFuture} that is completed with a {@code boolean}
     *        indicating whether this app is eligible for backup.
     */
    void isAppEligibleForBackup(in PackageInfo targetPackage, boolean isFullBackup,
            in AndroidFuture<boolean> resultFuture);

    /**
     * Ask the transport about current quota for backup size of the package.
     *
     * @param packageName ID of package to provide the quota.
     * @param isFullBackup If set, transport should return limit for full data backup, otherwise
     *                     for key-value backup.
     * @param resultFuture an {@link AndroidFuture} that is completed with a {@code long}: current
     *        limit on full data backup size in bytes.
     */
    void getBackupQuota(String packageName, boolean isFullBackup,
            in AndroidFuture<long> resultFuture);

    // full restore stuff

    /**
     * Ask the transport to provide data for the "current" package being restored.  This
     * is the package that was just reported by {@link #nextRestorePackage()} as having
     * {@link RestoreDescription#TYPE_FULL_STREAM} data.
     *
     * The transport writes some data to the socket supplied to this call, and returns
     * the number of bytes written.  The system will then read that many bytes and
     * stream them to the application's agent for restore, then will call this method again
     * to receive the next chunk of the archive.  This sequence will be repeated until the
     * transport returns zero indicating that all of the package's data has been delivered
     * (or returns a negative value indicating some sort of hard error condition at the
     * transport level).
     *
     * <p>After this method returns zero, the system will then call
     * {@link #getNextFullRestorePackage()} to begin the restore process for the next
     * application, and the sequence begins again.
     *
     * <p>The transport should always close this socket when returning from this method.
     * Do not cache this socket across multiple calls or you may leak file descriptors.
     *
     * @param socket The file descriptor that the transport will use for delivering the
     *    streamed archive.  The transport must close this socket in all cases when returning
     *    from this method.
     * @param callback a callback that is completed with an {@code int}: 0 when
     *    no more data for the current package is available.  A positive value indicates the
     *    presence of that many bytes to be delivered to the app.  Any negative return value is
     *    treated as equivalent to {@link BackupTransport#TRANSPORT_ERROR}, indicating a fatal error
     *    condition that precludes further restore operations on the current dataset.
     */
    void getNextFullRestoreDataChunk(in ParcelFileDescriptor socket,
            in ITransportStatusCallback callback);

    /**
     * If the OS encounters an error while processing {@link RestoreDescription#TYPE_FULL_STREAM}
     * data for restore, it will invoke this method to tell the transport that it should
     * abandon the data download for the current package.  The OS will then either call
     * {@link #nextRestorePackage()} again to move on to restoring the next package in the
     * set being iterated over, or will call {@link #finishRestore()} to shut down the restore
     * operation.
     *
     * @param callback a callback that is completed with {@code int}, which is
     *    one of: {@link #TRANSPORT_OK} if the transport was successful in shutting down the current
     *    stream cleanly, or {@link #TRANSPORT_ERROR} to indicate a serious transport-level failure.
     *    If the transport reports an error here, the entire restore operation will immediately be
     *    finished with no further attempts to restore app data.
     */
    void abortFullRestore(in ITransportStatusCallback callback);

    /**
     * @param resultFuture an {@link AndroidFuture} that is completed with an {@code int}: flags
     * with additional information about the transport, which is accessible to the
     * {@link android.app.backup.BackupAgent}. This allows the agent to decide what to backup or
     * restore based on properties of the transport.
     *
     * <p>For supported flags see {@link android.app.backup.BackupAgent}.
     */
    void getTransportFlags(in AndroidFuture<int> resultFuture);

    /**
     * Ask the transport for a {@link IBackupManagerMonitor} instance which will be used by the
     * framework to report logging events back to the transport.
     *
     * Backups requested from outside the framework may pass in a monitor with the request,
     * however backups initiated by the framework will call this method to retrieve one.
     */
    void getBackupManagerMonitor(in AndroidFuture<IBackupManagerMonitor> resultFuture);
}