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: * *
{@literal
*
*
- * The service to be scheduled must be defined in the manifest with an intent-filter:
- *
- * {@literal
- *
- *
- *
- *
- * }
- *
* 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;
diff --git a/library/core/src/main/java/com/google/android/exoplayer2/offline/DownloadService.java b/library/core/src/main/java/com/google/android/exoplayer2/offline/DownloadService.java
index 342ac9f38a..7011be391e 100644
--- a/library/core/src/main/java/com/google/android/exoplayer2/offline/DownloadService.java
+++ b/library/core/src/main/java/com/google/android/exoplayer2/offline/DownloadService.java
@@ -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 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:
*
* 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();
}
diff --git a/library/dash/src/test/java/com/google/android/exoplayer2/source/dash/offline/DownloadServiceDashTest.java b/library/dash/src/test/java/com/google/android/exoplayer2/source/dash/offline/DownloadServiceDashTest.java
index 8b9f628d47..9f6534f2c8 100644
--- a/library/dash/src/test/java/com/google/android/exoplayer2/source/dash/offline/DownloadServiceDashTest.java
+++ b/library/dash/src/test/java/com/google/android/exoplayer2/source/dash/offline/DownloadServiceDashTest.java
@@ -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();
{@literal
*
- *
- * The service to be scheduled must be defined in the manifest with an intent-filter:
- *
- * {@literal
- *
*/
@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;
diff --git a/library/core/src/main/java/com/google/android/exoplayer2/scheduler/RequirementsWatcher.java b/library/core/src/main/java/com/google/android/exoplayer2/scheduler/RequirementsWatcher.java
index 9509c7e5b8..46aa55f094 100644
--- a/library/core/src/main/java/com/google/android/exoplayer2/scheduler/RequirementsWatcher.java
+++ b/library/core/src/main/java/com/google/android/exoplayer2/scheduler/RequirementsWatcher.java
@@ -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");
}
diff --git a/library/core/src/main/java/com/google/android/exoplayer2/scheduler/Scheduler.java b/library/core/src/main/java/com/google/android/exoplayer2/scheduler/Scheduler.java
index 9a9c57443f..1b225d9a4d 100644
--- a/library/core/src/main/java/com/google/android/exoplayer2/scheduler/Scheduler.java
+++ b/library/core/src/main/java/com/google/android/exoplayer2/scheduler/Scheduler.java
@@ -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.
+ *