mirror of
https://github.com/androidx/media.git
synced 2025-04-30 06:46:50 +08:00
Improve scheduling
- Redefine Scheduler interface to better describe what implementations do. The previous version was too general, in that it allowed concrete DownloadService implementations to pass different Requirements to the base class and to the Scheduler. It's also difficult to see how that version could ever support dynamic updates to Requirements, which is probably a feature we'll need to add quite soon. - Fix a (probably theoretical) problem where static fields in DownloadService assumed only a single concrete implementation. - Stop using PlatformScheduler pre-API-21 in demo app, because it will fail. - Define default Requirements that require network. ------------- Created by MOE: https://github.com/google/moe MOE_MIGRATED_REVID=194785751
This commit is contained in:
olly
Oliver Woodman
parent
c1e3cb767e
commit
c6bedc6a85
@ -23,13 +23,13 @@ import com.google.android.exoplayer2.offline.DownloadService;
|
||||
import com.google.android.exoplayer2.offline.DownloaderConstructorHelper;
|
||||
import com.google.android.exoplayer2.offline.ProgressiveDownloadAction;
|
||||
import com.google.android.exoplayer2.scheduler.PlatformScheduler;
|
||||
import com.google.android.exoplayer2.scheduler.Requirements;
|
||||
import com.google.android.exoplayer2.source.dash.offline.DashDownloadAction;
|
||||
import com.google.android.exoplayer2.source.hls.offline.HlsDownloadAction;
|
||||
import com.google.android.exoplayer2.source.smoothstreaming.offline.SsDownloadAction;
|
||||
import com.google.android.exoplayer2.ui.DownloadNotificationUtil;
|
||||
import com.google.android.exoplayer2.util.ErrorMessageProvider;
|
||||
import com.google.android.exoplayer2.util.NotificationUtil;
|
||||
import com.google.android.exoplayer2.util.Util;
|
||||
|
||||
/** A service for downloading media. */
|
||||
public class DemoDownloadService extends DownloadService {
|
||||
@ -58,7 +58,7 @@ public class DemoDownloadService extends DownloadService {
|
||||
downloadManager =
|
||||
new DownloadManager(
|
||||
constructorHelper,
|
||||
/*maxSimultaneousDownloads=*/ 2,
|
||||
/* maxSimultaneousDownloads= */ 2,
|
||||
DownloadManager.DEFAULT_MIN_RETRY_COUNT,
|
||||
application.getDownloadActionFile(),
|
||||
DashDownloadAction.DESERIALIZER,
|
||||
@ -71,13 +71,7 @@ public class DemoDownloadService extends DownloadService {
|
||||
|
||||
@Override
|
||||
protected PlatformScheduler getScheduler() {
|
||||
return new PlatformScheduler(
|
||||
getApplicationContext(), getRequirements(), JOB_ID, ACTION_INIT, getPackageName());
|
||||
}
|
||||
|
||||
@Override
|
||||
protected Requirements getRequirements() {
|
||||
return new Requirements(Requirements.NETWORK_TYPE_UNMETERED, false, false);
|
||||
return Util.SDK_INT >= 21 ? new PlatformScheduler(this, JOB_ID) : null;
|
||||
}
|
||||
|
||||
@Override
|
||||
|
||||
@ -15,8 +15,6 @@
|
||||
*/
|
||||
package com.google.android.exoplayer2.ext.jobdispatcher;
|
||||
|
||||
import android.app.Notification;
|
||||
import android.app.Service;
|
||||
import android.content.Context;
|
||||
import android.content.Intent;
|
||||
import android.os.Bundle;
|
||||
@ -34,13 +32,8 @@ import com.google.android.exoplayer2.scheduler.Scheduler;
|
||||
import com.google.android.exoplayer2.util.Util;
|
||||
|
||||
/**
|
||||
* A {@link Scheduler} which uses {@link com.firebase.jobdispatcher.FirebaseJobDispatcher} to
|
||||
* schedule a {@link Service} to be started when its requirements are met. The started service must
|
||||
* call {@link Service#startForeground(int, Notification)} to make itself a foreground service upon
|
||||
* being started, as documented by {@link Service#startForegroundService(Intent)}.
|
||||
*
|
||||
* <p>To use {@link JobDispatcherScheduler} application needs to have RECEIVE_BOOT_COMPLETED
|
||||
* permission and you need to define JobDispatcherSchedulerService in your manifest:
|
||||
* A {@link Scheduler} that uses {@link FirebaseJobDispatcher}. To use this scheduler, you must add
|
||||
* {@link JobDispatcherSchedulerService} to your manifest:
|
||||
*
|
||||
* <pre>{@literal
|
||||
* <uses-permission android:name="android.permission.RECEIVE_BOOT_COMPLETED"/>
|
||||
@ -54,18 +47,6 @@ import com.google.android.exoplayer2.util.Util;
|
||||
* </service>
|
||||
* }</pre>
|
||||
*
|
||||
* The service to be scheduled must be defined in the manifest with an intent-filter:
|
||||
*
|
||||
* <pre>{@literal
|
||||
* <service android:name="MyJobService"
|
||||
* android:exported="false">
|
||||
* <intent-filter>
|
||||
* <action android:name="MyJobService.action"/>
|
||||
* <category android:name="android.intent.category.DEFAULT"/>
|
||||
* </intent-filter>
|
||||
* </service>
|
||||
* }</pre>
|
||||
*
|
||||
* <p>This Scheduler uses Google Play services but does not do any availability checks. Any uses
|
||||
* should be guarded with a call to {@code
|
||||
* GoogleApiAvailability#isGooglePlayServicesAvailable(android.content.Context)}
|
||||
@ -76,44 +57,37 @@ import com.google.android.exoplayer2.util.Util;
|
||||
public final class JobDispatcherScheduler implements Scheduler {
|
||||
|
||||
private static final String TAG = "JobDispatcherScheduler";
|
||||
private static final String SERVICE_ACTION = "SERVICE_ACTION";
|
||||
private static final String SERVICE_PACKAGE = "SERVICE_PACKAGE";
|
||||
private static final String REQUIREMENTS = "REQUIREMENTS";
|
||||
private static final String KEY_SERVICE_ACTION = "service_action";
|
||||
private static final String KEY_SERVICE_PACKAGE = "service_package";
|
||||
private static final String KEY_REQUIREMENTS = "requirements";
|
||||
|
||||
private final String jobTag;
|
||||
private final Job job;
|
||||
private final FirebaseJobDispatcher jobDispatcher;
|
||||
|
||||
/**
|
||||
* @param context Used to create a {@link FirebaseJobDispatcher} service.
|
||||
* @param requirements The requirements to execute the job.
|
||||
* @param jobTag Unique tag for the job. Using the same tag as a previous job can cause that job
|
||||
* to be replaced or canceled.
|
||||
* @param serviceAction The action which the service will be started with.
|
||||
* @param servicePackage The package of the service which contains the logic of the job.
|
||||
* @param context A context.
|
||||
* @param jobTag A tag for jobs scheduled by this instance. If the same tag was used by a previous
|
||||
* instance, anything scheduled by the previous instance will be canceled by this instance if
|
||||
* {@link #schedule(Requirements, String, String)} or {@link #cancel()} are called.
|
||||
*/
|
||||
public JobDispatcherScheduler(
|
||||
Context context,
|
||||
Requirements requirements,
|
||||
String jobTag,
|
||||
String serviceAction,
|
||||
String servicePackage) {
|
||||
this.jobDispatcher = new FirebaseJobDispatcher(new GooglePlayDriver(context));
|
||||
public JobDispatcherScheduler(Context context, String jobTag) {
|
||||
this.jobDispatcher =
|
||||
new FirebaseJobDispatcher(new GooglePlayDriver(context.getApplicationContext()));
|
||||
this.jobTag = jobTag;
|
||||
this.job = buildJob(jobDispatcher, requirements, jobTag, serviceAction, servicePackage);
|
||||
}
|
||||
|
||||
@Override
|
||||
public boolean schedule() {
|
||||
public boolean schedule(Requirements requirements, String serviceAction, String servicePackage) {
|
||||
Job job = buildJob(jobDispatcher, requirements, jobTag, serviceAction, servicePackage);
|
||||
int result = jobDispatcher.schedule(job);
|
||||
logd("Scheduling JobDispatcher job: " + jobTag + " result: " + result);
|
||||
logd("Scheduling job: " + jobTag + " result: " + result);
|
||||
return result == FirebaseJobDispatcher.SCHEDULE_RESULT_SUCCESS;
|
||||
}
|
||||
|
||||
@Override
|
||||
public boolean cancel() {
|
||||
int result = jobDispatcher.cancel(jobTag);
|
||||
logd("Canceling JobDispatcher job: " + jobTag + " result: " + result);
|
||||
logd("Canceling job: " + jobTag + " result: " + result);
|
||||
return result == FirebaseJobDispatcher.CANCEL_RESULT_SUCCESS;
|
||||
}
|
||||
|
||||
@ -151,13 +125,12 @@ public final class JobDispatcherScheduler implements Scheduler {
|
||||
}
|
||||
builder.setLifetime(Lifetime.FOREVER).setReplaceCurrent(true);
|
||||
|
||||
// Extras, work duration.
|
||||
Bundle extras = new Bundle();
|
||||
extras.putString(SERVICE_ACTION, serviceAction);
|
||||
extras.putString(SERVICE_PACKAGE, servicePackage);
|
||||
extras.putInt(REQUIREMENTS, requirements.getRequirementsData());
|
||||
|
||||
extras.putString(KEY_SERVICE_ACTION, serviceAction);
|
||||
extras.putString(KEY_SERVICE_PACKAGE, servicePackage);
|
||||
extras.putInt(KEY_REQUIREMENTS, requirements.getRequirementsData());
|
||||
builder.setExtras(extras);
|
||||
|
||||
return builder.build();
|
||||
}
|
||||
|
||||
@ -167,22 +140,22 @@ public final class JobDispatcherScheduler implements Scheduler {
|
||||
}
|
||||
}
|
||||
|
||||
/** A {@link JobService} to start a service if the requirements are met. */
|
||||
/** A {@link JobService} that starts the target service if the requirements are met. */
|
||||
public static final class JobDispatcherSchedulerService extends JobService {
|
||||
@Override
|
||||
public boolean onStartJob(JobParameters params) {
|
||||
logd("JobDispatcherSchedulerService is started");
|
||||
Bundle extras = params.getExtras();
|
||||
Requirements requirements = new Requirements(extras.getInt(REQUIREMENTS));
|
||||
Requirements requirements = new Requirements(extras.getInt(KEY_REQUIREMENTS));
|
||||
if (requirements.checkRequirements(this)) {
|
||||
logd("requirements are met");
|
||||
String serviceAction = extras.getString(SERVICE_ACTION);
|
||||
String servicePackage = extras.getString(SERVICE_PACKAGE);
|
||||
logd("Requirements are met");
|
||||
String serviceAction = extras.getString(KEY_SERVICE_ACTION);
|
||||
String servicePackage = extras.getString(KEY_SERVICE_PACKAGE);
|
||||
Intent intent = new Intent(serviceAction).setPackage(servicePackage);
|
||||
logd("starting service action: " + serviceAction + " package: " + servicePackage);
|
||||
logd("Starting service action: " + serviceAction + " package: " + servicePackage);
|
||||
Util.startForegroundService(this, intent);
|
||||
} else {
|
||||
logd("requirements are not met");
|
||||
logd("Requirements are not met");
|
||||
jobFinished(params, /* needsReschedule */ true);
|
||||
}
|
||||
return false;
|
||||
|
||||
@ -32,6 +32,7 @@ import com.google.android.exoplayer2.scheduler.Scheduler;
|
||||
import com.google.android.exoplayer2.util.NotificationUtil;
|
||||
import com.google.android.exoplayer2.util.Util;
|
||||
import java.io.IOException;
|
||||
import java.util.HashMap;
|
||||
|
||||
/**
|
||||
* A {@link Service} that downloads streams in the background.
|
||||
@ -56,8 +57,8 @@ public abstract class DownloadService extends Service {
|
||||
private static final String ACTION_START =
|
||||
"com.google.android.exoplayer.downloadService.action.START";
|
||||
|
||||
/** A {@link DownloadAction} to be executed. */
|
||||
public static final String DOWNLOAD_ACTION = "DownloadAction";
|
||||
/** Key for the {@link DownloadAction} in an {@link #ACTION_ADD} intent. */
|
||||
public static final String KEY_DOWNLOAD_ACTION = "download_action";
|
||||
|
||||
/** Default foreground notification update interval in milliseconds. */
|
||||
public static final long DEFAULT_FOREGROUND_NOTIFICATION_UPDATE_INTERVAL = 1000;
|
||||
@ -65,10 +66,11 @@ public abstract class DownloadService extends Service {
|
||||
private static final String TAG = "DownloadService";
|
||||
private static final boolean DEBUG = false;
|
||||
|
||||
// Keep requirementsWatcher and scheduler alive beyond DownloadService life span (until the app is
|
||||
// killed) because it may take long time for Scheduler to start the service.
|
||||
private static RequirementsWatcher requirementsWatcher;
|
||||
private static Scheduler scheduler;
|
||||
// Keep the requirements helper for each DownloadService as long as there are tasks (and the
|
||||
// process is running). This allows tasks to resume when there's no scheduler. It may also allow
|
||||
// tasks the resume more quickly than when relying on the scheduler alone.
|
||||
private static final HashMap<Class<? extends DownloadService>, RequirementsHelper>
|
||||
requirementsHelpers = new HashMap<>();
|
||||
|
||||
private final ForegroundNotificationUpdater foregroundNotificationUpdater;
|
||||
private final @Nullable String channelId;
|
||||
@ -108,10 +110,10 @@ public abstract class DownloadService extends Service {
|
||||
/**
|
||||
* Creates a DownloadService.
|
||||
*
|
||||
* @param foregroundNotificationId The notification id for the foreground notification, must not
|
||||
* @param foregroundNotificationId The notification id for the foreground notification. Must not
|
||||
* be 0.
|
||||
* @param foregroundNotificationUpdateInterval The maximum interval to update foreground
|
||||
* notification, in milliseconds.
|
||||
* @param foregroundNotificationUpdateInterval The maximum interval between updates to the
|
||||
* foreground notification, in milliseconds.
|
||||
* @param channelId An id for a low priority notification channel to create, or {@code null} if
|
||||
* the app will take care of creating a notification channel if needed. If specified, must be
|
||||
* unique per package and the value may be truncated if it is too long.
|
||||
@ -144,7 +146,7 @@ public abstract class DownloadService extends Service {
|
||||
Context context, Class<? extends DownloadService> clazz, DownloadAction downloadAction) {
|
||||
return new Intent(context, clazz)
|
||||
.setAction(ACTION_ADD)
|
||||
.putExtra(DOWNLOAD_ACTION, downloadAction.toByteArray());
|
||||
.putExtra(KEY_DOWNLOAD_ACTION, downloadAction.toByteArray());
|
||||
}
|
||||
|
||||
/**
|
||||
@ -171,19 +173,17 @@ public abstract class DownloadService extends Service {
|
||||
downloadManager = getDownloadManager();
|
||||
downloadListener = new DownloadListener();
|
||||
downloadManager.addListener(downloadListener);
|
||||
if (requirementsWatcher == null) {
|
||||
Requirements requirements = getRequirements();
|
||||
if (requirements != null) {
|
||||
scheduler = getScheduler();
|
||||
RequirementsListener listener =
|
||||
new RequirementsListener(getApplicationContext(), getClass(), scheduler);
|
||||
requirementsWatcher =
|
||||
new RequirementsWatcher(getApplicationContext(), listener, requirements);
|
||||
requirementsWatcher.start();
|
||||
} else {
|
||||
downloadManager.startDownloads();
|
||||
|
||||
RequirementsHelper requirementsHelper;
|
||||
synchronized (requirementsHelpers) {
|
||||
Class<? extends DownloadService> clazz = getClass();
|
||||
requirementsHelper = requirementsHelpers.get(clazz);
|
||||
if (requirementsHelper == null) {
|
||||
requirementsHelper = new RequirementsHelper(this, getRequirements(), getScheduler(), clazz);
|
||||
requirementsHelpers.put(clazz, requirementsHelper);
|
||||
}
|
||||
}
|
||||
requirementsHelper.start();
|
||||
}
|
||||
|
||||
@Override
|
||||
@ -192,13 +192,11 @@ public abstract class DownloadService extends Service {
|
||||
foregroundNotificationUpdater.stopPeriodicUpdates();
|
||||
downloadManager.removeListener(downloadListener);
|
||||
if (downloadManager.getTaskCount() == 0) {
|
||||
if (requirementsWatcher != null) {
|
||||
requirementsWatcher.stop();
|
||||
requirementsWatcher = null;
|
||||
}
|
||||
if (scheduler != null) {
|
||||
scheduler.cancel();
|
||||
scheduler = null;
|
||||
synchronized (requirementsHelpers) {
|
||||
RequirementsHelper requirementsHelper = requirementsHelpers.remove(getClass());
|
||||
if (requirementsHelper != null) {
|
||||
requirementsHelper.stop();
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
@ -223,14 +221,14 @@ public abstract class DownloadService extends Service {
|
||||
// or remove tasks loaded from file, they will start if the requirements are met.
|
||||
break;
|
||||
case ACTION_ADD:
|
||||
byte[] actionData = intent.getByteArrayExtra(DOWNLOAD_ACTION);
|
||||
byte[] actionData = intent.getByteArrayExtra(KEY_DOWNLOAD_ACTION);
|
||||
if (actionData == null) {
|
||||
onCommandError(new IllegalArgumentException("DownloadAction is missing."));
|
||||
Log.e(TAG, "Ignoring ADD action with no action data");
|
||||
} else {
|
||||
try {
|
||||
downloadManager.handleAction(actionData);
|
||||
} catch (IOException e) {
|
||||
onCommandError(e);
|
||||
Log.e(TAG, "Failed to handle ADD action", e);
|
||||
}
|
||||
}
|
||||
break;
|
||||
@ -241,7 +239,7 @@ public abstract class DownloadService extends Service {
|
||||
downloadManager.startDownloads();
|
||||
break;
|
||||
default:
|
||||
onCommandError(new IllegalArgumentException("Unknown action: " + intentAction));
|
||||
Log.e(TAG, "Ignoring unrecognized action: " + intentAction);
|
||||
break;
|
||||
}
|
||||
if (downloadManager.isIdle()) {
|
||||
@ -257,14 +255,19 @@ public abstract class DownloadService extends Service {
|
||||
protected abstract DownloadManager getDownloadManager();
|
||||
|
||||
/**
|
||||
* Returns a {@link Scheduler} which contains a job to initialize {@link DownloadService} when the
|
||||
* requirements are met, or null. If not null, scheduler is used to start downloads even when the
|
||||
* app isn't running.
|
||||
* Returns a {@link Scheduler} to restart the service when requirements allowing downloads to take
|
||||
* place are met. If {@code null}, the service will only be restarted if the process is still in
|
||||
* memory when the requirements are met.
|
||||
*/
|
||||
protected abstract @Nullable Scheduler getScheduler();
|
||||
|
||||
/** Returns requirements for downloads to take place, or null. */
|
||||
protected abstract @Nullable Requirements getRequirements();
|
||||
/**
|
||||
* Returns requirements for downloads to take place. By default the only requirement is that the
|
||||
* device has network connectivity.
|
||||
*/
|
||||
protected Requirements getRequirements() {
|
||||
return new Requirements(Requirements.NETWORK_TYPE_ANY, false, false);
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns a notification to be displayed when this service running in the foreground.
|
||||
@ -287,14 +290,9 @@ public abstract class DownloadService extends Service {
|
||||
// Do nothing.
|
||||
}
|
||||
|
||||
private void onCommandError(Exception error) {
|
||||
Log.e(TAG, "Command error", error);
|
||||
}
|
||||
|
||||
private void stop() {
|
||||
foregroundNotificationUpdater.stopPeriodicUpdates();
|
||||
// Make sure startForeground is called before stopping.
|
||||
// Workaround for [Internal: b/69424260]
|
||||
// Make sure startForeground is called before stopping. Workaround for [Internal: b/69424260].
|
||||
if (Util.SDK_INT >= 26) {
|
||||
foregroundNotificationUpdater.showNotificationIfNotAlready();
|
||||
}
|
||||
@ -372,17 +370,35 @@ public abstract class DownloadService extends Service {
|
||||
}
|
||||
}
|
||||
|
||||
private static final class RequirementsListener implements RequirementsWatcher.Listener {
|
||||
private static final class RequirementsHelper implements RequirementsWatcher.Listener {
|
||||
|
||||
private final Context context;
|
||||
private final Requirements requirements;
|
||||
private final @Nullable Scheduler scheduler;
|
||||
private final Class<? extends DownloadService> serviceClass;
|
||||
private final Scheduler scheduler;
|
||||
private final RequirementsWatcher requirementsWatcher;
|
||||
|
||||
private RequirementsListener(
|
||||
Context context, Class<? extends DownloadService> serviceClass, Scheduler scheduler) {
|
||||
private RequirementsHelper(
|
||||
Context context,
|
||||
Requirements requirements,
|
||||
@Nullable Scheduler scheduler,
|
||||
Class<? extends DownloadService> serviceClass) {
|
||||
this.context = context;
|
||||
this.serviceClass = serviceClass;
|
||||
this.requirements = requirements;
|
||||
this.scheduler = scheduler;
|
||||
this.serviceClass = serviceClass;
|
||||
requirementsWatcher = new RequirementsWatcher(context, this, requirements);
|
||||
}
|
||||
|
||||
public void start() {
|
||||
requirementsWatcher.start();
|
||||
}
|
||||
|
||||
public void stop() {
|
||||
requirementsWatcher.stop();
|
||||
if (scheduler != null) {
|
||||
scheduler.cancel();
|
||||
}
|
||||
}
|
||||
|
||||
@Override
|
||||
@ -397,7 +413,8 @@ public abstract class DownloadService extends Service {
|
||||
public void requirementsNotMet(RequirementsWatcher requirementsWatcher) {
|
||||
startServiceWithAction(DownloadService.ACTION_STOP);
|
||||
if (scheduler != null) {
|
||||
if (!scheduler.schedule()) {
|
||||
boolean success = scheduler.schedule(requirements, context.getPackageName(), ACTION_INIT);
|
||||
if (!success) {
|
||||
Log.e(TAG, "Scheduling downloads failed.");
|
||||
}
|
||||
}
|
||||
|
||||
@ -16,8 +16,6 @@
|
||||
package com.google.android.exoplayer2.scheduler;
|
||||
|
||||
import android.annotation.TargetApi;
|
||||
import android.app.Notification;
|
||||
import android.app.Service;
|
||||
import android.app.job.JobInfo;
|
||||
import android.app.job.JobParameters;
|
||||
import android.app.job.JobScheduler;
|
||||
@ -31,76 +29,55 @@ import android.util.Log;
|
||||
import com.google.android.exoplayer2.util.Util;
|
||||
|
||||
/**
|
||||
* A {@link Scheduler} which uses {@link android.app.job.JobScheduler} to schedule a {@link Service}
|
||||
* to be started when its requirements are met. The started service must call {@link
|
||||
* Service#startForeground(int, Notification)} to make itself a foreground service upon being
|
||||
* started, as documented by {@link Service#startForegroundService(Intent)}.
|
||||
*
|
||||
* <p>To use {@link PlatformScheduler} application needs to have RECEIVE_BOOT_COMPLETED permission
|
||||
* and you need to define PlatformSchedulerService in your manifest:
|
||||
* A {@link Scheduler} that uses {@link JobScheduler}. To use this scheduler, you must add {@link
|
||||
* PlatformSchedulerService} to your manifest:
|
||||
*
|
||||
* <pre>{@literal
|
||||
* <uses-permission android:name="android.permission.RECEIVE_BOOT_COMPLETED"/>
|
||||
*
|
||||
* <service android:name="com.google.android.exoplayer2.util.scheduler.PlatformScheduler$PlatformSchedulerService"
|
||||
* android:permission="android.permission.BIND_JOB_SERVICE"
|
||||
* android:exported="true"/>
|
||||
* }</pre>
|
||||
*
|
||||
* The service to be scheduled must be defined in the manifest with an intent-filter:
|
||||
*
|
||||
* <pre>{@literal
|
||||
* <service android:name="MyJobService"
|
||||
* android:exported="false">
|
||||
* <intent-filter>
|
||||
* <action android:name="MyJobService.action"/>
|
||||
* <category android:name="android.intent.category.DEFAULT"/>
|
||||
* </intent-filter>
|
||||
* </service>
|
||||
* android:permission="android.permission.BIND_JOB_SERVICE"
|
||||
* android:exported="true"/>
|
||||
* }</pre>
|
||||
*/
|
||||
@TargetApi(21)
|
||||
public final class PlatformScheduler implements Scheduler {
|
||||
|
||||
private static final String TAG = "PlatformScheduler";
|
||||
private static final String SERVICE_ACTION = "SERVICE_ACTION";
|
||||
private static final String SERVICE_PACKAGE = "SERVICE_PACKAGE";
|
||||
private static final String REQUIREMENTS = "REQUIREMENTS";
|
||||
private static final String KEY_SERVICE_ACTION = "service_action";
|
||||
private static final String KEY_SERVICE_PACKAGE = "service_package";
|
||||
private static final String KEY_REQUIREMENTS = "requirements";
|
||||
|
||||
private final int jobId;
|
||||
private final JobInfo jobInfo;
|
||||
private final ComponentName jobServiceComponentName;
|
||||
private final JobScheduler jobScheduler;
|
||||
|
||||
/**
|
||||
* @param context Used to access to {@link JobScheduler} service.
|
||||
* @param requirements The requirements to execute the job.
|
||||
* @param jobId Unique identifier for the job. Using the same id as a previous job can cause that
|
||||
* job to be replaced or canceled.
|
||||
* @param serviceAction The action which the service will be started with.
|
||||
* @param servicePackage The package of the service which contains the logic of the job.
|
||||
* @param context Any context.
|
||||
* @param jobId An identifier for the jobs scheduled by this instance. If the same identifier was
|
||||
* used by a previous instance, anything scheduled by the previous instance will be canceled
|
||||
* by this instance if {@link #schedule(Requirements, String, String)} or {@link #cancel()}
|
||||
* are called.
|
||||
*/
|
||||
@RequiresPermission(android.Manifest.permission.RECEIVE_BOOT_COMPLETED)
|
||||
public PlatformScheduler(
|
||||
Context context,
|
||||
Requirements requirements,
|
||||
int jobId,
|
||||
String serviceAction,
|
||||
String servicePackage) {
|
||||
public PlatformScheduler(Context context, int jobId) {
|
||||
this.jobId = jobId;
|
||||
this.jobInfo = buildJobInfo(context, requirements, jobId, serviceAction, servicePackage);
|
||||
this.jobScheduler = (JobScheduler) context.getSystemService(Context.JOB_SCHEDULER_SERVICE);
|
||||
jobServiceComponentName = new ComponentName(context, PlatformSchedulerService.class);
|
||||
jobScheduler = (JobScheduler) context.getSystemService(Context.JOB_SCHEDULER_SERVICE);
|
||||
}
|
||||
|
||||
@Override
|
||||
public boolean schedule() {
|
||||
public boolean schedule(Requirements requirements, String servicePackage, String serviceAction) {
|
||||
JobInfo jobInfo =
|
||||
buildJobInfo(jobId, jobServiceComponentName, requirements, serviceAction, servicePackage);
|
||||
int result = jobScheduler.schedule(jobInfo);
|
||||
logd("Scheduling JobScheduler job: " + jobId + " result: " + result);
|
||||
logd("Scheduling job: " + jobId + " result: " + result);
|
||||
return result == JobScheduler.RESULT_SUCCESS;
|
||||
}
|
||||
|
||||
@Override
|
||||
public boolean cancel() {
|
||||
logd("Canceling JobScheduler job: " + jobId);
|
||||
logd("Canceling job: " + jobId);
|
||||
jobScheduler.cancel(jobId);
|
||||
return true;
|
||||
}
|
||||
@ -108,13 +85,12 @@ public final class PlatformScheduler implements Scheduler {
|
||||
// @RequiresPermission constructor annotation should ensure the permission is present.
|
||||
@SuppressWarnings("MissingPermission")
|
||||
private static JobInfo buildJobInfo(
|
||||
Context context,
|
||||
Requirements requirements,
|
||||
int jobId,
|
||||
ComponentName jobServiceComponentName,
|
||||
Requirements requirements,
|
||||
String serviceAction,
|
||||
String servicePackage) {
|
||||
JobInfo.Builder builder =
|
||||
new JobInfo.Builder(jobId, new ComponentName(context, PlatformSchedulerService.class));
|
||||
JobInfo.Builder builder = new JobInfo.Builder(jobId, jobServiceComponentName);
|
||||
|
||||
int networkType;
|
||||
switch (requirements.getRequiredNetworkType()) {
|
||||
@ -150,13 +126,12 @@ public final class PlatformScheduler implements Scheduler {
|
||||
builder.setRequiresCharging(requirements.isChargingRequired());
|
||||
builder.setPersisted(true);
|
||||
|
||||
// Extras, work duration.
|
||||
PersistableBundle extras = new PersistableBundle();
|
||||
extras.putString(SERVICE_ACTION, serviceAction);
|
||||
extras.putString(SERVICE_PACKAGE, servicePackage);
|
||||
extras.putInt(REQUIREMENTS, requirements.getRequirementsData());
|
||||
|
||||
extras.putString(KEY_SERVICE_ACTION, serviceAction);
|
||||
extras.putString(KEY_SERVICE_PACKAGE, servicePackage);
|
||||
extras.putInt(KEY_REQUIREMENTS, requirements.getRequirementsData());
|
||||
builder.setExtras(extras);
|
||||
|
||||
return builder.build();
|
||||
}
|
||||
|
||||
@ -166,22 +141,22 @@ public final class PlatformScheduler implements Scheduler {
|
||||
}
|
||||
}
|
||||
|
||||
/** A {@link JobService} to start a service if the requirements are met. */
|
||||
/** A {@link JobService} that starts the target service if the requirements are met. */
|
||||
public static final class PlatformSchedulerService extends JobService {
|
||||
@Override
|
||||
public boolean onStartJob(JobParameters params) {
|
||||
logd("PlatformSchedulerService is started");
|
||||
logd("PlatformSchedulerService started");
|
||||
PersistableBundle extras = params.getExtras();
|
||||
Requirements requirements = new Requirements(extras.getInt(REQUIREMENTS));
|
||||
Requirements requirements = new Requirements(extras.getInt(KEY_REQUIREMENTS));
|
||||
if (requirements.checkRequirements(this)) {
|
||||
logd("requirements are met");
|
||||
String serviceAction = extras.getString(SERVICE_ACTION);
|
||||
String servicePackage = extras.getString(SERVICE_PACKAGE);
|
||||
logd("Requirements are met");
|
||||
String serviceAction = extras.getString(KEY_SERVICE_ACTION);
|
||||
String servicePackage = extras.getString(KEY_SERVICE_PACKAGE);
|
||||
Intent intent = new Intent(serviceAction).setPackage(servicePackage);
|
||||
logd("starting service action: " + serviceAction + " package: " + servicePackage);
|
||||
logd("Starting service action: " + serviceAction + " package: " + servicePackage);
|
||||
Util.startForegroundService(this, intent);
|
||||
} else {
|
||||
logd("requirements are not met");
|
||||
logd("Requirements are not met");
|
||||
jobFinished(params, /* needsReschedule */ true);
|
||||
}
|
||||
return false;
|
||||
|
||||
@ -69,14 +69,14 @@ public final class RequirementsWatcher {
|
||||
private CapabilityValidatedCallback networkCallback;
|
||||
|
||||
/**
|
||||
* @param context Used to register for broadcasts.
|
||||
* @param context Any context.
|
||||
* @param listener Notified whether the {@link Requirements} are met.
|
||||
* @param requirements The requirements to watch.
|
||||
*/
|
||||
public RequirementsWatcher(Context context, Listener listener, Requirements requirements) {
|
||||
this.requirements = requirements;
|
||||
this.listener = listener;
|
||||
this.context = context;
|
||||
this.context = context.getApplicationContext();
|
||||
logd(this + " created");
|
||||
}
|
||||
|
||||
|
||||
@ -15,25 +15,36 @@
|
||||
*/
|
||||
package com.google.android.exoplayer2.scheduler;
|
||||
|
||||
/**
|
||||
* Implementer of this interface schedules one implementation specific job to be run when some
|
||||
* requirements are met even if the app isn't running.
|
||||
*/
|
||||
import android.app.Notification;
|
||||
import android.app.Service;
|
||||
import android.content.Intent;
|
||||
|
||||
/** Schedules a service to be started in the foreground when some {@link Requirements} are met. */
|
||||
public interface Scheduler {
|
||||
|
||||
/*package*/ boolean DEBUG = false;
|
||||
/* package */ boolean DEBUG = false;
|
||||
|
||||
/**
|
||||
* Schedules the job to be run when the requirements are met.
|
||||
* Schedules a service to be started in the foreground when some {@link Requirements} are met.
|
||||
* Anything that was previously scheduled will be canceled.
|
||||
*
|
||||
* @return Whether the job scheduled successfully.
|
||||
* <p>The service to be started must be declared in the manifest of {@code servicePackage} with an
|
||||
* intent filter containing {@code serviceAction}. Note that when started with {@code
|
||||
* serviceAction}, the service must call {@link Service#startForeground(int, Notification)} to
|
||||
* make itself a foreground service, as documented by {@link
|
||||
* Service#startForegroundService(Intent)}.
|
||||
*
|
||||
* @param requirements The requirements.
|
||||
* @param servicePackage The package name.
|
||||
* @param serviceAction The action with which the service will be started.
|
||||
* @return Whether scheduling was successful.
|
||||
*/
|
||||
boolean schedule();
|
||||
boolean schedule(Requirements requirements, String servicePackage, String serviceAction);
|
||||
|
||||
/**
|
||||
* Cancels any previous schedule.
|
||||
* Cancels anything that was previously scheduled, or else does nothing.
|
||||
*
|
||||
* @return Whether the job cancelled successfully.
|
||||
* @return Whether cancellation was successful.
|
||||
*/
|
||||
boolean cancel();
|
||||
}
|
||||
|
||||
@ -45,6 +45,7 @@ import java.io.File;
|
||||
import java.io.IOException;
|
||||
import org.junit.After;
|
||||
import org.junit.Before;
|
||||
import org.junit.Ignore;
|
||||
import org.junit.Test;
|
||||
import org.junit.runner.RunWith;
|
||||
import org.mockito.Mockito;
|
||||
@ -180,6 +181,7 @@ public class DownloadServiceDashTest {
|
||||
dummyMainThread.release();
|
||||
}
|
||||
|
||||
@Ignore // b/78877092
|
||||
@Test
|
||||
public void testMultipleDownloadAction() throws Throwable {
|
||||
downloadKeys(fakeRepresentationKey1);
|
||||
@ -190,6 +192,7 @@ public class DownloadServiceDashTest {
|
||||
assertCachedData(cache, fakeDataSet);
|
||||
}
|
||||
|
||||
@Ignore // b/78877092
|
||||
@Test
|
||||
public void testRemoveAction() throws Throwable {
|
||||
downloadKeys(fakeRepresentationKey1, fakeRepresentationKey2);
|
||||
@ -203,6 +206,7 @@ public class DownloadServiceDashTest {
|
||||
assertCacheEmpty(cache);
|
||||
}
|
||||
|
||||
@Ignore // b/78877092
|
||||
@Test
|
||||
public void testRemoveBeforeDownloadComplete() throws Throwable {
|
||||
pauseDownloadCondition = new ConditionVariable();
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user