- * This must be implemented for all data transfer jobs. - * - * @see JobInfo.Builder#setEstimatedNetworkBytes(long, long) - * @see JobInfo#NETWORK_BYTES_UNKNOWN - */ - // TODO(255371817): specify the actual time JS will wait for progress before requesting - @BytesLong - public long getTransferredDownloadBytes() { - if (Compatibility.isChangeEnabled(THROW_ON_INVALID_DATA_TRANSFER_IMPLEMENTATION)) { - // Regular jobs don't have to implement this and JobScheduler won't call this API for - // non-data transfer jobs. - throw new RuntimeException("Not implemented. Must override in a subclass."); - } - return 0; - } - - /** - * Get the number of bytes the app has successfully downloaded for this job. JobScheduler - * will call this if the job has specified positive estimated upload bytes and - * {@link #updateTransferredNetworkBytes(JobParameters, long, long)} - * hasn't been called recently. - * - *
- * This must be implemented for all data transfer jobs. - * - * @see JobInfo.Builder#setEstimatedNetworkBytes(long, long) - * @see JobInfo#NETWORK_BYTES_UNKNOWN - */ - // TODO(255371817): specify the actual time JS will wait for progress before requesting - @BytesLong - public long getTransferredUploadBytes() { - if (Compatibility.isChangeEnabled(THROW_ON_INVALID_DATA_TRANSFER_IMPLEMENTATION)) { - // Regular jobs don't have to implement this and JobScheduler won't call this API for - // non-data transfer jobs. - throw new RuntimeException("Not implemented. Must override in a subclass."); - } - return 0; - } - - /** - * Get the number of bytes the app has successfully downloaded for this job. JobScheduler - * will call this if the job has specified positive estimated download bytes and - * {@link #updateTransferredNetworkBytes(JobParameters, JobWorkItem, long, long)} - * hasn't been called recently and the job has - * {@link JobWorkItem JobWorkItems} that have been - * {@link JobParameters#dequeueWork dequeued} but not - * {@link JobParameters#completeWork(JobWorkItem) completed}. - * - *
- * This must be implemented for all data transfer jobs. - * - * @see JobInfo#NETWORK_BYTES_UNKNOWN - */ - // TODO(255371817): specify the actual time JS will wait for progress before requesting - @BytesLong - public long getTransferredDownloadBytes(@NonNull JobWorkItem item) { - if (item == null) { - return getTransferredDownloadBytes(); - } - if (Compatibility.isChangeEnabled(THROW_ON_INVALID_DATA_TRANSFER_IMPLEMENTATION)) { - // Regular jobs don't have to implement this and JobScheduler won't call this API for - // non-data transfer jobs. - throw new RuntimeException("Not implemented. Must override in a subclass."); - } - return 0; - } - - /** - * Get the number of bytes the app has successfully downloaded for this job. JobScheduler - * will call this if the job has specified positive estimated upload bytes and - * {@link #updateTransferredNetworkBytes(JobParameters, JobWorkItem, long, long)} - * hasn't been called recently and the job has - * {@link JobWorkItem JobWorkItems} that have been - * {@link JobParameters#dequeueWork dequeued} but not - * {@link JobParameters#completeWork(JobWorkItem) completed}. - * - *
- * This must be implemented for all data transfer jobs. - * - * @see JobInfo#NETWORK_BYTES_UNKNOWN - */ - // TODO(255371817): specify the actual time JS will wait for progress before requesting - @BytesLong - public long getTransferredUploadBytes(@NonNull JobWorkItem item) { - if (item == null) { - return getTransferredUploadBytes(); - } - if (Compatibility.isChangeEnabled(THROW_ON_INVALID_DATA_TRANSFER_IMPLEMENTATION)) { - // Regular jobs don't have to implement this and JobScheduler won't call this API for - // non-data transfer jobs. - throw new RuntimeException("Not implemented. Must override in a subclass."); - } - return 0; - } } diff --git a/apex/jobscheduler/framework/java/android/app/job/JobServiceEngine.java b/apex/jobscheduler/framework/java/android/app/job/JobServiceEngine.java index 6c4b6863ae9e6..3d43d20e79556 100644 --- a/apex/jobscheduler/framework/java/android/app/job/JobServiceEngine.java +++ b/apex/jobscheduler/framework/java/android/app/job/JobServiceEngine.java @@ -16,13 +16,7 @@ package android.app.job; -import static android.app.job.JobScheduler.THROW_ON_INVALID_DATA_TRANSFER_IMPLEMENTATION; - -import android.annotation.BytesLong; -import android.annotation.NonNull; -import android.annotation.Nullable; import android.app.Service; -import android.compat.Compatibility; import android.content.Intent; import android.os.Handler; import android.os.IBinder; @@ -31,8 +25,6 @@ import android.os.Message; import android.os.RemoteException; import android.util.Log; -import com.android.internal.os.SomeArgs; - import java.lang.ref.WeakReference; /** @@ -59,20 +51,6 @@ public abstract class JobServiceEngine { * Message that the client has completed execution of this job. */ private static final int MSG_JOB_FINISHED = 2; - /** - * Message that will result in a call to - * {@link #getTransferredDownloadBytes(JobParameters, JobWorkItem)}. - */ - private static final int MSG_GET_TRANSFERRED_DOWNLOAD_BYTES = 3; - /** - * Message that will result in a call to - * {@link #getTransferredUploadBytes(JobParameters, JobWorkItem)}. - */ - private static final int MSG_GET_TRANSFERRED_UPLOAD_BYTES = 4; - /** Message that the client wants to update JobScheduler of the data transfer progress. */ - private static final int MSG_UPDATE_TRANSFERRED_NETWORK_BYTES = 5; - /** Message that the client wants to update JobScheduler of the estimated transfer size. */ - private static final int MSG_UPDATE_ESTIMATED_NETWORK_BYTES = 6; private final IJobService mBinder; @@ -89,32 +67,6 @@ public abstract class JobServiceEngine { mService = new WeakReference<>(service); } - @Override - public void getTransferredDownloadBytes(@NonNull JobParameters jobParams, - @Nullable JobWorkItem jobWorkItem) throws RemoteException { - JobServiceEngine service = mService.get(); - if (service != null) { - SomeArgs args = SomeArgs.obtain(); - args.arg1 = jobParams; - args.arg2 = jobWorkItem; - service.mHandler.obtainMessage(MSG_GET_TRANSFERRED_DOWNLOAD_BYTES, args) - .sendToTarget(); - } - } - - @Override - public void getTransferredUploadBytes(@NonNull JobParameters jobParams, - @Nullable JobWorkItem jobWorkItem) throws RemoteException { - JobServiceEngine service = mService.get(); - if (service != null) { - SomeArgs args = SomeArgs.obtain(); - args.arg1 = jobParams; - args.arg2 = jobWorkItem; - service.mHandler.obtainMessage(MSG_GET_TRANSFERRED_UPLOAD_BYTES, args) - .sendToTarget(); - } - } - @Override public void startJob(JobParameters jobParams) throws RemoteException { JobServiceEngine service = mService.get(); @@ -146,9 +98,9 @@ public abstract class JobServiceEngine { @Override public void handleMessage(Message msg) { + final JobParameters params = (JobParameters) msg.obj; switch (msg.what) { - case MSG_EXECUTE_JOB: { - final JobParameters params = (JobParameters) msg.obj; + case MSG_EXECUTE_JOB: try { boolean workOngoing = JobServiceEngine.this.onStartJob(params); ackStartMessage(params, workOngoing); @@ -157,9 +109,7 @@ public abstract class JobServiceEngine { throw new RuntimeException(e); } break; - } - case MSG_STOP_JOB: { - final JobParameters params = (JobParameters) msg.obj; + case MSG_STOP_JOB: try { boolean ret = JobServiceEngine.this.onStopJob(params); ackStopMessage(params, ret); @@ -168,9 +118,7 @@ public abstract class JobServiceEngine { throw new RuntimeException(e); } break; - } - case MSG_JOB_FINISHED: { - final JobParameters params = (JobParameters) msg.obj; + case MSG_JOB_FINISHED: final boolean needsReschedule = (msg.arg2 == 1); IJobCallback callback = params.getCallback(); if (callback != null) { @@ -184,117 +132,19 @@ public abstract class JobServiceEngine { Log.e(TAG, "finishJob() called for a nonexistent job id."); } break; - } - case MSG_GET_TRANSFERRED_DOWNLOAD_BYTES: { - final SomeArgs args = (SomeArgs) msg.obj; - final JobParameters params = (JobParameters) args.arg1; - final JobWorkItem item = (JobWorkItem) args.arg2; - try { - long ret = JobServiceEngine.this.getTransferredDownloadBytes(params, item); - ackGetTransferredDownloadBytesMessage(params, item, ret); - } catch (Exception e) { - Log.e(TAG, "Application unable to handle getTransferredDownloadBytes.", e); - throw new RuntimeException(e); - } - args.recycle(); - break; - } - case MSG_GET_TRANSFERRED_UPLOAD_BYTES: { - final SomeArgs args = (SomeArgs) msg.obj; - final JobParameters params = (JobParameters) args.arg1; - final JobWorkItem item = (JobWorkItem) args.arg2; - try { - long ret = JobServiceEngine.this.getTransferredUploadBytes(params, item); - ackGetTransferredUploadBytesMessage(params, item, ret); - } catch (Exception e) { - Log.e(TAG, "Application unable to handle getTransferredUploadBytes.", e); - throw new RuntimeException(e); - } - args.recycle(); - break; - } - case MSG_UPDATE_TRANSFERRED_NETWORK_BYTES: { - final SomeArgs args = (SomeArgs) msg.obj; - final JobParameters params = (JobParameters) args.arg1; - IJobCallback callback = params.getCallback(); - if (callback != null) { - try { - callback.updateTransferredNetworkBytes(params.getJobId(), - (JobWorkItem) args.arg2, args.argl1, args.argl2); - } catch (RemoteException e) { - Log.e(TAG, "Error updating data transfer progress to system:" - + " binder has gone away."); - } - } else { - Log.e(TAG, "updateDataTransferProgress() called for a nonexistent job id."); - } - args.recycle(); - break; - } - case MSG_UPDATE_ESTIMATED_NETWORK_BYTES: { - final SomeArgs args = (SomeArgs) msg.obj; - final JobParameters params = (JobParameters) args.arg1; - IJobCallback callback = params.getCallback(); - if (callback != null) { - try { - callback.updateEstimatedNetworkBytes(params.getJobId(), - (JobWorkItem) args.arg2, args.argl1, args.argl2); - } catch (RemoteException e) { - Log.e(TAG, "Error updating estimated transfer size to system:" - + " binder has gone away."); - } - } else { - Log.e(TAG, - "updateEstimatedNetworkBytes() called for a nonexistent job id."); - } - args.recycle(); - break; - } default: Log.e(TAG, "Unrecognised message received."); break; } } - private void ackGetTransferredDownloadBytesMessage(@NonNull JobParameters params, - @Nullable JobWorkItem item, long progress) { - final IJobCallback callback = params.getCallback(); - final int jobId = params.getJobId(); - final int workId = item == null ? -1 : item.getWorkId(); - if (callback != null) { - try { - callback.acknowledgeGetTransferredDownloadBytesMessage(jobId, workId, progress); - } catch (RemoteException e) { - Log.e(TAG, "System unreachable for returning progress."); - } - } else if (Log.isLoggable(TAG, Log.DEBUG)) { - Log.d(TAG, "Attempting to ack a job that has already been processed."); - } - } - - private void ackGetTransferredUploadBytesMessage(@NonNull JobParameters params, - @Nullable JobWorkItem item, long progress) { - final IJobCallback callback = params.getCallback(); - final int jobId = params.getJobId(); - final int workId = item == null ? -1 : item.getWorkId(); - if (callback != null) { - try { - callback.acknowledgeGetTransferredUploadBytesMessage(jobId, workId, progress); - } catch (RemoteException e) { - Log.e(TAG, "System unreachable for returning progress."); - } - } else if (Log.isLoggable(TAG, Log.DEBUG)) { - Log.d(TAG, "Attempting to ack a job that has already been processed."); - } - } - private void ackStartMessage(JobParameters params, boolean workOngoing) { final IJobCallback callback = params.getCallback(); final int jobId = params.getJobId(); if (callback != null) { try { callback.acknowledgeStartMessage(jobId, workOngoing); - } catch (RemoteException e) { + } catch(RemoteException e) { Log.e(TAG, "System unreachable for starting job."); } } else { @@ -363,69 +213,4 @@ public abstract class JobServiceEngine { m.arg2 = needsReschedule ? 1 : 0; m.sendToTarget(); } - - /** - * Engine's request to get how much data has been downloaded. - * - * @see JobService#getTransferredDownloadBytes() - */ - @BytesLong - public long getTransferredDownloadBytes(@NonNull JobParameters params, - @Nullable JobWorkItem item) { - if (Compatibility.isChangeEnabled(THROW_ON_INVALID_DATA_TRANSFER_IMPLEMENTATION)) { - throw new RuntimeException("Not implemented. Must override in a subclass."); - } - return 0; - } - - /** - * Engine's request to get how much data has been uploaded. - * - * @see JobService#getTransferredUploadBytes() - */ - @BytesLong - public long getTransferredUploadBytes(@NonNull JobParameters params, - @Nullable JobWorkItem item) { - if (Compatibility.isChangeEnabled(THROW_ON_INVALID_DATA_TRANSFER_IMPLEMENTATION)) { - throw new RuntimeException("Not implemented. Must override in a subclass."); - } - return 0; - } - - /** - * Call in to engine to report data transfer progress. - * - * @see JobService#updateTransferredNetworkBytes(JobParameters, long, long) - */ - public void updateTransferredNetworkBytes(@NonNull JobParameters params, - @Nullable JobWorkItem item, long downloadBytes, long uploadBytes) { - if (params == null) { - throw new NullPointerException("params"); - } - SomeArgs args = SomeArgs.obtain(); - args.arg1 = params; - args.arg2 = item; - args.argl1 = downloadBytes; - args.argl2 = uploadBytes; - mHandler.obtainMessage(MSG_UPDATE_TRANSFERRED_NETWORK_BYTES, args).sendToTarget(); - } - - /** - * Call in to engine to report data transfer progress. - * - * @see JobService#updateEstimatedNetworkBytes(JobParameters, JobWorkItem, long, long) - */ - public void updateEstimatedNetworkBytes(@NonNull JobParameters params, - @NonNull JobWorkItem item, - @BytesLong long downloadBytes, @BytesLong long uploadBytes) { - if (params == null) { - throw new NullPointerException("params"); - } - SomeArgs args = SomeArgs.obtain(); - args.arg1 = params; - args.arg2 = item; - args.argl1 = downloadBytes; - args.argl2 = uploadBytes; - mHandler.obtainMessage(MSG_UPDATE_ESTIMATED_NETWORK_BYTES, args).sendToTarget(); - } } \ No newline at end of file diff --git a/apex/jobscheduler/service/java/com/android/server/job/JobServiceContext.java b/apex/jobscheduler/service/java/com/android/server/job/JobServiceContext.java index 9aa6b1c298ef1..334647ef83314 100644 --- a/apex/jobscheduler/service/java/com/android/server/job/JobServiceContext.java +++ b/apex/jobscheduler/service/java/com/android/server/job/JobServiceContext.java @@ -21,7 +21,6 @@ import static android.app.job.JobInfo.getPriorityString; import static com.android.server.job.JobConcurrencyManager.WORK_TYPE_NONE; import static com.android.server.job.JobSchedulerService.sElapsedRealtimeClock; -import android.annotation.BytesLong; import android.annotation.NonNull; import android.annotation.Nullable; import android.app.job.IJobCallback; @@ -187,18 +186,6 @@ public final class JobServiceContext implements ServiceConnection { public String mStoppedReason; public long mStoppedTime; - @Override - public void acknowledgeGetTransferredDownloadBytesMessage(int jobId, int workId, - @BytesLong long transferredBytes) { - doAcknowledgeGetTransferredDownloadBytesMessage(this, jobId, workId, transferredBytes); - } - - @Override - public void acknowledgeGetTransferredUploadBytesMessage(int jobId, int workId, - @BytesLong long transferredBytes) { - doAcknowledgeGetTransferredUploadBytesMessage(this, jobId, workId, transferredBytes); - } - @Override public void acknowledgeStartMessage(int jobId, boolean ongoing) { doAcknowledgeStartMessage(this, jobId, ongoing); @@ -223,18 +210,6 @@ public final class JobServiceContext implements ServiceConnection { public void jobFinished(int jobId, boolean reschedule) { doJobFinished(this, jobId, reschedule); } - - @Override - public void updateEstimatedNetworkBytes(int jobId, JobWorkItem item, - long downloadBytes, long uploadBytes) { - doUpdateEstimatedNetworkBytes(this, jobId, item, downloadBytes, uploadBytes); - } - - @Override - public void updateTransferredNetworkBytes(int jobId, JobWorkItem item, - long downloadBytes, long uploadBytes) { - doUpdateTransferredNetworkBytes(this, jobId, item, downloadBytes, uploadBytes); - } } JobServiceContext(JobSchedulerService service, JobConcurrencyManager concurrencyManager, @@ -531,16 +506,6 @@ public final class JobServiceContext implements ServiceConnection { } } - private void doAcknowledgeGetTransferredDownloadBytesMessage(JobCallback jobCallback, int jobId, - int workId, @BytesLong long transferredBytes) { - // TODO(255393346): Make sure apps call this appropriately and monitor for abuse - } - - private void doAcknowledgeGetTransferredUploadBytesMessage(JobCallback jobCallback, int jobId, - int workId, @BytesLong long transferredBytes) { - // TODO(255393346): Make sure apps call this appropriately and monitor for abuse - } - void doAcknowledgeStopMessage(JobCallback cb, int jobId, boolean reschedule) { doCallback(cb, reschedule, null); } @@ -593,16 +558,6 @@ public final class JobServiceContext implements ServiceConnection { } } - private void doUpdateTransferredNetworkBytes(JobCallback jobCallback, int jobId, - @Nullable JobWorkItem item, long downloadBytes, long uploadBytes) { - // TODO(255393346): Make sure apps call this appropriately and monitor for abuse - } - - private void doUpdateEstimatedNetworkBytes(JobCallback jobCallback, int jobId, - @Nullable JobWorkItem item, long downloadBytes, long uploadBytes) { - // TODO(255393346): Make sure apps call this appropriately and monitor for abuse - } - /** * We acquire/release a wakelock on onServiceConnected/unbindService. This mirrors the work * we intend to send to the client - we stop sending work when the service is unbound so until diff --git a/core/api/current.txt b/core/api/current.txt index dc9d7d5dd1aba..26c28c9936e4c 100644 --- a/core/api/current.txt +++ b/core/api/current.txt @@ -8474,31 +8474,19 @@ package android.app.job { public abstract class JobService extends android.app.Service { ctor public JobService(); - method public long getTransferredDownloadBytes(); - method public long getTransferredDownloadBytes(@NonNull android.app.job.JobWorkItem); - method public long getTransferredUploadBytes(); - method public long getTransferredUploadBytes(@NonNull android.app.job.JobWorkItem); method public final void jobFinished(android.app.job.JobParameters, boolean); method public final android.os.IBinder onBind(android.content.Intent); method public abstract boolean onStartJob(android.app.job.JobParameters); method public abstract boolean onStopJob(android.app.job.JobParameters); - method public final void updateEstimatedNetworkBytes(@NonNull android.app.job.JobParameters, long, long); - method public final void updateEstimatedNetworkBytes(@NonNull android.app.job.JobParameters, @NonNull android.app.job.JobWorkItem, long, long); - method public final void updateTransferredNetworkBytes(@NonNull android.app.job.JobParameters, long, long); - method public final void updateTransferredNetworkBytes(@NonNull android.app.job.JobParameters, @NonNull android.app.job.JobWorkItem, long, long); field public static final String PERMISSION_BIND = "android.permission.BIND_JOB_SERVICE"; } public abstract class JobServiceEngine { ctor public JobServiceEngine(android.app.Service); method public final android.os.IBinder getBinder(); - method public long getTransferredDownloadBytes(@NonNull android.app.job.JobParameters, @Nullable android.app.job.JobWorkItem); - method public long getTransferredUploadBytes(@NonNull android.app.job.JobParameters, @Nullable android.app.job.JobWorkItem); method public void jobFinished(android.app.job.JobParameters, boolean); method public abstract boolean onStartJob(android.app.job.JobParameters); method public abstract boolean onStopJob(android.app.job.JobParameters); - method public void updateEstimatedNetworkBytes(@NonNull android.app.job.JobParameters, @NonNull android.app.job.JobWorkItem, long, long); - method public void updateTransferredNetworkBytes(@NonNull android.app.job.JobParameters, @Nullable android.app.job.JobWorkItem, long, long); } public final class JobWorkItem implements android.os.Parcelable {