src/com/android/phone/vvm/omtp/scheduling/RetryPolicy.java

/*
 * 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.phone.vvm.omtp.scheduling;

import android.content.Intent;
import android.telecom.PhoneAccountHandle;
import com.android.phone.VoicemailStatus;
import com.android.phone.vvm.omtp.VvmLog;
import com.android.phone.vvm.omtp.utils.PhoneAccountHandleConverter;

/**
 * A task with this policy will automatically re-queue itself if {@link BaseTask#fail()} has been
 * called during {@link BaseTask#onExecuteInBackgroundThread()}. A task will be retried at most
 * <code>retryLimit</code> times and with a <code>retryDelayMillis</code> interval in between.
 */
public class RetryPolicy implements Policy {

    private static final String TAG = "RetryPolicy";
    private static final String EXTRA_RETRY_COUNT = "extra_retry_count";

    private final int mRetryLimit;
    private final int mRetryDelayMillis;

    private BaseTask mTask;

    private int mRetryCount;
    private boolean mFailed;

    private VoicemailStatus.DeferredEditor mVoicemailStatusEditor;

    public RetryPolicy(int retryLimit, int retryDelayMillis) {
        mRetryLimit = retryLimit;
        mRetryDelayMillis = retryDelayMillis;
    }

    private boolean hasMoreRetries() {
        return mRetryCount < mRetryLimit;
    }

    /**
     * Error status should only be set if retries has exhausted or the task is successful. Status
     * writes to this editor will be deferred until the task has ended, and will only be committed
     * if the task is successful or there are no retries left.
     */
    public VoicemailStatus.Editor getVoicemailStatusEditor() {
        return mVoicemailStatusEditor;
    }

    @Override
    public void onCreate(BaseTask task, Intent intent, int flags, int startId) {
        mTask = task;
        mRetryCount = intent.getIntExtra(EXTRA_RETRY_COUNT, 0);
        if (mRetryCount > 0) {
            VvmLog.d(TAG, "retry #" + mRetryCount + " for " + mTask + " queued, executing in "
                    + mRetryDelayMillis);
            mTask.setExecutionTime(mTask.getTimeMillis() + mRetryDelayMillis);
        }
        PhoneAccountHandle phoneAccountHandle = PhoneAccountHandleConverter
                .fromSubId(task.getSubId());
        if (phoneAccountHandle == null) {
            VvmLog.e(TAG, "null phone account for subId " + task.getSubId());
            // This should never happen, but continue on if it does. The status write will be
            // discarded.
        }
        mVoicemailStatusEditor = VoicemailStatus
                .deferredEdit(task.getContext(), phoneAccountHandle);
    }

    @Override
    public void onBeforeExecute() {

    }

    @Override
    public void onCompleted() {
        if (!mFailed || !hasMoreRetries()) {
            if (!mFailed) {
                VvmLog.d(TAG, mTask.toString() + " completed successfully");
            }
            if (!hasMoreRetries()) {
                VvmLog.d(TAG, "Retry limit for " + mTask + " reached");
            }
            VvmLog.i(TAG, "committing deferred status: " + mVoicemailStatusEditor.getValues());
            mVoicemailStatusEditor.deferredApply();
            return;
        }
        VvmLog.i(TAG, "discarding deferred status: " + mVoicemailStatusEditor.getValues());
        Intent intent = mTask.createRestartIntent();
        intent.putExtra(EXTRA_RETRY_COUNT, mRetryCount + 1);

        mTask.getContext().startService(intent);
    }

    @Override
    public void onFail() {
        mFailed = true;
    }

    @Override
    public void onDuplicatedTaskAdded() {

    }
}