Donate to e Foundation | Murena handsets with /e/OS | Own a part of Murena! Learn more

Commit 54058364 authored by Qingxi Li's avatar Qingxi Li
Browse files

Add API to get eUICC's OTA status 

The function will return current eUICC's OTA status and requests calling
app has WRITE_EMBEDDED_SUBSCRIPTIONS.

Test: E2E
Bug: 37279356
Change-Id: I823ed7aa9d86530c4bebd4c0b1a00f0c607105ed
parent ab71a936

Android.bp

+1 −0
Original line number Diff line number Diff line
@@ -256,6 +256,7 @@ java_library { 
        "core/java/android/service/euicc/IGetEidCallback.aidl",

        "core/java/android/service/euicc/IGetEuiccInfoCallback.aidl",

        "core/java/android/service/euicc/IGetEuiccProfileInfoListCallback.aidl",

        "core/java/android/service/euicc/IGetOtaStatusCallback.aidl",

        "core/java/android/service/euicc/IRetainSubscriptionsForFactoryResetCallback.aidl",

        "core/java/android/service/euicc/ISwitchToSubscriptionCallback.aidl",

        "core/java/android/service/euicc/IUpdateSubscriptionNicknameCallback.aidl",

core/java/android/service/euicc/EuiccService.java

+26 −0
Original line number Diff line number Diff line
@@ -23,6 +23,7 @@ import android.os.IBinder; 
import android.os.RemoteException;

import android.telephony.euicc.DownloadableSubscription;

import android.telephony.euicc.EuiccInfo;

import android.telephony.euicc.EuiccManager.OtaStatus;

import android.util.ArraySet;



import java.util.concurrent.LinkedBlockingQueue;
@@ -202,6 +203,16 @@ public abstract class EuiccService extends Service { 
    // TODO(b/36260308): Update doc when we have multi-SIM support.

    public abstract String onGetEid(int slotId);



    /**

     * Return the status of OTA update.

     *

     * @param slotId ID of the SIM slot to use for the operation. This is currently not populated

     *     but is here to future-proof the APIs.

     * @return The status of Euicc OTA update.

     * @see android.telephony.euicc.EuiccManager#getOtaStatus

     */

    public abstract @OtaStatus int onGetOtaStatus(int slotId);



    /**

     * Populate {@link DownloadableSubscription} metadata for the given downloadable subscription.

     *
@@ -384,6 +395,21 @@ public abstract class EuiccService extends Service { 
            });

        }



        @Override

        public void getOtaStatus(int slotId, IGetOtaStatusCallback callback) {

            mExecutor.execute(new Runnable() {

                @Override

                public void run() {

                    int status = EuiccService.this.onGetOtaStatus(slotId);

                    try {

                        callback.onSuccess(status);

                    } catch (RemoteException e) {

                        // Can't communicate with the phone process; ignore.

                    }

                }

            });

        }



        @Override

        public void getDownloadableSubscriptionMetadata(int slotId,

                DownloadableSubscription subscription,

core/java/android/service/euicc/IEuiccService.aidl

+2 −0
Original line number Diff line number Diff line
@@ -24,6 +24,7 @@ import android.service.euicc.IGetDownloadableSubscriptionMetadataCallback; 
import android.service.euicc.IGetEidCallback;

import android.service.euicc.IGetEuiccInfoCallback;

import android.service.euicc.IGetEuiccProfileInfoListCallback;

import android.service.euicc.IGetOtaStatusCallback;

import android.service.euicc.IRetainSubscriptionsForFactoryResetCallback;

import android.service.euicc.ISwitchToSubscriptionCallback;

import android.service.euicc.IUpdateSubscriptionNicknameCallback;
@@ -37,6 +38,7 @@ oneway interface IEuiccService { 
    void getDownloadableSubscriptionMetadata(int slotId, in DownloadableSubscription subscription,

            boolean forceDeactivateSim, in IGetDownloadableSubscriptionMetadataCallback callback);

    void getEid(int slotId, in IGetEidCallback callback);

    void getOtaStatus(int slotId, in IGetOtaStatusCallback callback);

    void getEuiccProfileInfoList(int slotId, in IGetEuiccProfileInfoListCallback callback);

    void getDefaultDownloadableSubscriptionList(int slotId, boolean forceDeactivateSim,

            in IGetDefaultDownloadableSubscriptionListCallback callback);

core/java/android/service/euicc/IGetOtaStatusCallback.aidl

0 → 100644
+22 −0
Original line number Diff line number Diff line 
/*

 * Copyright (C) 2017 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.euicc;



/** @hide */

oneway interface IGetOtaStatusCallback {

    void onSuccess(int status);

}
 
 No newline at end of file

telephony/java/android/telephony/euicc/EuiccManager.java

+54 −0
Original line number Diff line number Diff line
@@ -15,8 +15,10 @@ 
 */

package android.telephony.euicc;



import android.annotation.IntDef;

import android.annotation.Nullable;

import android.annotation.SdkConstant;

import android.annotation.SystemApi;

import android.app.Activity;

import android.app.PendingIntent;

import android.content.Context;
@@ -29,6 +31,9 @@ import android.os.ServiceManager; 


import com.android.internal.telephony.euicc.IEuiccController;



import java.lang.annotation.Retention;

import java.lang.annotation.RetentionPolicy;



/**

 * EuiccManager is the application interface to eUICCs, or eSIMs/embedded SIMs.

 *
@@ -167,6 +172,35 @@ public class EuiccManager { 
     */

    public static final String META_DATA_CARRIER_ICON = "android.telephony.euicc.carriericon";



    /**

     * Euicc OTA update status which can be got by {@link #getOtaStatus}

     * @hide

     */

    @Retention(RetentionPolicy.SOURCE)

    @IntDef(prefix = {"EUICC_OTA_"}, value = {

            EUICC_OTA_IN_PROGRESS,

            EUICC_OTA_FAILED,

            EUICC_OTA_SUCCEEDED,

            EUICC_OTA_NOT_NEEDED,

            EUICC_OTA_STATUS_UNAVAILABLE



    })

    public @interface OtaStatus{}



    /**

     * An OTA is in progress. During this time, the eUICC is not available and the user may lose

     * network access.

     */

    public static final int EUICC_OTA_IN_PROGRESS = 1;

    /** The OTA update failed. */

    public static final int EUICC_OTA_FAILED = 2;

    /** The OTA update finished successfully. */

    public static final int EUICC_OTA_SUCCEEDED = 3;

    /** The OTA update not needed since current eUICC OS is latest. */

    public static final int EUICC_OTA_NOT_NEEDED = 4;

    /** The OTA status is unavailable since eUICC service is unavailable. */

    public static final int EUICC_OTA_STATUS_UNAVAILABLE = 5;



    private final Context mContext;



    /** @hide */
@@ -210,6 +244,26 @@ public class EuiccManager { 
        }

    }



    /**

     * Returns the current status of eUICC OTA.

     *

     * <p>Requires the {@link android.Manifest.permission#WRITE_EMBEDDED_SUBSCRIPTIONS} permission.

     *

     * @return the status of eUICC OTA. If {@link #isEnabled()} is false or the eUICC is not ready,

     *     {@link OtaStatus#EUICC_OTA_STATUS_UNAVAILABLE} will be returned.

     */

    @SystemApi

    public int getOtaStatus() {

        if (!isEnabled()) {

            return EUICC_OTA_STATUS_UNAVAILABLE;

        }

        try {

            return getIEuiccController().getOtaStatus();

        } catch (RemoteException e) {

            throw e.rethrowFromSystemServer();

        }

    }



    /**

     * Attempt to download the given {@link DownloadableSubscription}.

     *