/*
 * 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 android.service.autofill;

import android.annotation.NonNull;
import android.annotation.Nullable;
import android.app.Activity;
import android.content.IntentSender;
import android.os.RemoteException;

import com.android.internal.util.Preconditions;

Handles save requests from the AutofillService into the Activity being autofilled. /**
 * Handles save requests from the {@link AutofillService} into the {@link Activity} being
 * autofilled.
 */
public final class SaveCallback {
    private final ISaveCallback mCallback;
    private boolean mCalled;

    
@hide
/** @hide */
    SaveCallback(ISaveCallback callback) {
        mCallback = callback;
    }

    
Notifies the Android System that an AutofillService.onSaveRequest(SaveRequest, SaveCallback) was successfully handled by the service. 
Throws:
IllegalStateException – if this method, onSuccess(IntentSender), or onFailure(CharSequence) was already called./**
     * Notifies the Android System that an
     * {@link AutofillService#onSaveRequest(SaveRequest, SaveCallback)} was successfully handled
     * by the service.
     *
     * @throws IllegalStateException if this method, {@link #onSuccess(IntentSender)}, or
     * {@link #onFailure(CharSequence)} was already called.
     */
    public void onSuccess() {
        onSuccessInternal(null);
    }

    
Notifies the Android System that an AutofillService.onSaveRequest(SaveRequest, SaveCallback) was successfully handled by the service. 
This method is useful when the service requires extra work—for example, launching an
activity asking the user to authenticate first —before it can process the request,
as the intent will be launched from the context of the activity being autofilled and hence
will be part of that activity's stack.
Params:
intentSender – intent that will be launched from the context of activity being
autofilled.
Throws:
IllegalStateException – if this method, onSuccess(), or onFailure(CharSequence) was already called./**
     * Notifies the Android System that an
     * {@link AutofillService#onSaveRequest(SaveRequest, SaveCallback)} was successfully handled
     * by the service.
     *
     * <p>This method is useful when the service requires extra work&mdash;for example, launching an
     * activity asking the user to authenticate first &mdash;before it can process the request,
     * as the intent will be launched from the context of the activity being autofilled and hence
     * will be part of that activity's stack.
     *
     * @param intentSender intent that will be launched from the context of activity being
     * autofilled.
     *
     * @throws IllegalStateException if this method, {@link #onSuccess()},
     * or {@link #onFailure(CharSequence)} was already called.
     */
    public void onSuccess(@NonNull IntentSender intentSender) {
        onSuccessInternal(Preconditions.checkNotNull(intentSender));
    }

    private void onSuccessInternal(@Nullable IntentSender intentSender) {
        assertNotCalled();
        mCalled = true;
        try {
            mCallback.onSuccess(intentSender);
        } catch (RemoteException e) {
            e.rethrowAsRuntimeException();
        }
    }

    
Notifies the Android System that an AutofillService.onSaveRequest(SaveRequest, SaveCallback) could not be handled by the service. 
This method should only be called when the service could not handle the request right away and could not recover or retry it. If the service could retry or recover, it could keep the SaveRequest and call onSuccess() instead. 
Note: The Android System displays an UI with the supplied error message; if you prefer to show your own message, call onSuccess() or onSuccess(IntentSender) instead. 
Params:
message – error message to be displayed to the user. Note:  this message is displayed on logcat logs and should not contain PII (Personally Identifiable Information, such as username or email address).
Throws:
IllegalStateException – if this method, onSuccess(), or onSuccess(IntentSender) was already called./**
     * Notifies the Android System that an
     * {@link AutofillService#onSaveRequest(SaveRequest, SaveCallback)} could not be handled
     * by the service.
     *
     * <p>This method should only be called when the service could not handle the request right away
     * and could not recover or retry it. If the service could retry or recover, it could keep
     * the {@link SaveRequest} and call {@link #onSuccess()} instead.
     *
     * <p><b>Note:</b> The Android System displays an UI with the supplied error message; if
     * you prefer to show your own message, call {@link #onSuccess()} or
     * {@link #onSuccess(IntentSender)} instead.
     *
     * @param message error message to be displayed to the user. <b>Note: </b> this message is
     * displayed on {@code logcat} logs and should not contain PII (Personally Identifiable
     * Information, such as username or email address).
     *
     * @throws IllegalStateException if this method, {@link #onSuccess()},
     * or {@link #onSuccess(IntentSender)} was already called.
     */
    public void onFailure(CharSequence message) {
        assertNotCalled();
        mCalled = true;
        try {
            mCallback.onFailure(message);
        } catch (RemoteException e) {
            e.rethrowAsRuntimeException();
        }
    }

    private void assertNotCalled() {
        if (mCalled) {
            throw new IllegalStateException("Already called");
        }
    }
}