1 /* 2 * Copyright (C) 2017 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 com.android.server.backup; 18 19 import android.annotation.IntDef; 20 21 import java.lang.annotation.Retention; 22 import java.lang.annotation.RetentionPolicy; 23 24 /** Interface and methods used by the asynchronous-with-timeout backup/restore operations. */ 25 public interface BackupRestoreTask { 26 27 // Execute one tick of whatever state machine the task implements execute()28 void execute(); 29 30 // An operation that wanted a callback has completed operationComplete(long result)31 void operationComplete(long result); 32 33 @Retention(RetentionPolicy.SOURCE) 34 @IntDef({ 35 CancellationReason.TIMEOUT, 36 CancellationReason.AGENT_DISCONNECTED, 37 CancellationReason.EXTERNAL, 38 CancellationReason.SCHEDULED_JOB_STOPPED, 39 }) 40 @interface CancellationReason { 41 // The task timed out. 42 int TIMEOUT = 0; 43 // The agent went away before the task was able to finish (e.g. due to an app crash). 44 int AGENT_DISCONNECTED = 1; 45 // An external caller cancelled the operation (e.g. via BackupManager#cancelBackups). 46 int EXTERNAL = 2; 47 // The job scheduler has stopped an ongoing scheduled backup pass. 48 int SCHEDULED_JOB_STOPPED = 3; 49 } 50 51 /** The task is cancelled for the given {@link CancellationReason}. */ handleCancel(@ancellationReason int cancellationReason)52 void handleCancel(@CancellationReason int cancellationReason); 53 } 54