1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
|
/*
* Copyright (C) 2016 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.voicemail.impl.scheduling;
import android.content.Context;
import android.content.Intent;
import android.os.SystemClock;
import android.support.annotation.CallSuper;
import android.support.annotation.MainThread;
import android.support.annotation.NonNull;
import android.support.annotation.WorkerThread;
import android.telecom.PhoneAccountHandle;
import com.android.voicemail.impl.Assert;
import com.android.voicemail.impl.NeededForTesting;
import java.util.ArrayList;
import java.util.List;
/**
* Provides common utilities for task implementations, such as execution time and managing {@link
* Policy}
*/
public abstract class BaseTask implements Task {
private static final String EXTRA_PHONE_ACCOUNT_HANDLE = "extra_phone_account_handle";
private Context mContext;
private int mId;
private PhoneAccountHandle mPhoneAccountHandle;
private boolean mHasStarted;
private volatile boolean mHasFailed;
@NonNull private final List<Policy> mPolicies = new ArrayList<>();
private long mExecutionTime;
private static Clock sClock = new Clock();
protected BaseTask(int id) {
mId = id;
mExecutionTime = getTimeMillis();
}
/**
* Modify the task ID to prevent arbitrary task from executing. Can only be called before {@link
* #onCreate(Context, Intent, int, int)} returns.
*/
@MainThread
public void setId(int id) {
Assert.isMainThread();
mId = id;
}
@MainThread
public boolean hasStarted() {
Assert.isMainThread();
return mHasStarted;
}
@MainThread
public boolean hasFailed() {
Assert.isMainThread();
return mHasFailed;
}
public Context getContext() {
return mContext;
}
public PhoneAccountHandle getPhoneAccountHandle() {
return mPhoneAccountHandle;
}
/**
* Should be call in the constructor or {@link Policy#onCreate(BaseTask, Intent, int, int)} will
* be missed.
*/
@MainThread
public BaseTask addPolicy(Policy policy) {
Assert.isMainThread();
mPolicies.add(policy);
return this;
}
/**
* Indicate the task has failed. {@link Policy#onFail()} will be triggered once the execution
* ends. This mechanism is used by policies for actions such as determining whether to schedule a
* retry. Must be call inside {@link #onExecuteInBackgroundThread()}
*/
@WorkerThread
public void fail() {
Assert.isNotMainThread();
mHasFailed = true;
}
@MainThread
public void setExecutionTime(long timeMillis) {
Assert.isMainThread();
mExecutionTime = timeMillis;
}
public long getTimeMillis() {
return sClock.getTimeMillis();
}
/**
* Creates an intent that can be used to restart the current task. Derived class should build
* their intent upon this.
*/
public Intent createRestartIntent() {
return createIntent(getContext(), this.getClass(), mPhoneAccountHandle);
}
/**
* Creates an intent that can be used to start the {@link TaskSchedulerService}. Derived class
* should build their intent upon this.
*/
public static Intent createIntent(
Context context, Class<? extends BaseTask> task, PhoneAccountHandle phoneAccountHandle) {
Intent intent = TaskSchedulerService.createIntent(context, task);
intent.putExtra(EXTRA_PHONE_ACCOUNT_HANDLE, phoneAccountHandle);
return intent;
}
@Override
public TaskId getId() {
return new TaskId(mId, mPhoneAccountHandle);
}
@Override
@CallSuper
public void onCreate(Context context, Intent intent, int flags, int startId) {
mContext = context;
mPhoneAccountHandle = intent.getParcelableExtra(EXTRA_PHONE_ACCOUNT_HANDLE);
for (Policy policy : mPolicies) {
policy.onCreate(this, intent, flags, startId);
}
}
@Override
public long getReadyInMilliSeconds() {
return mExecutionTime - getTimeMillis();
}
@Override
@CallSuper
public void onBeforeExecute() {
for (Policy policy : mPolicies) {
policy.onBeforeExecute();
}
mHasStarted = true;
}
@Override
@CallSuper
public void onCompleted() {
if (mHasFailed) {
for (Policy policy : mPolicies) {
policy.onFail();
}
}
for (Policy policy : mPolicies) {
policy.onCompleted();
}
}
@Override
public void onDuplicatedTaskAdded(Task task) {
for (Policy policy : mPolicies) {
policy.onDuplicatedTaskAdded();
}
}
@NeededForTesting
static class Clock {
public long getTimeMillis() {
return SystemClock.elapsedRealtime();
}
}
/** Used to replace the clock with an deterministic clock */
@NeededForTesting
static void setClockForTesting(Clock clock) {
sClock = clock;
}
}
|
