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

Commit bcf024c2 authored by Hakjun Choi's avatar Hakjun Choi
Browse files

Improve error handling for register/unregister ntn signal strength related APIs 

1. Remove return error code for registerForNtnSignalStreangth
2. Throw all security/invalid parameter as an exception for the register API
3. Remove callback from callback map when register operation fails.
4. If an unregisterForNtnSignalStrength is requested for unregistered or invalid callback, throws IllegalArgumentException error instead of silent failing.

Bug: 306111250
Test: atest SatelliteControllerTest, SatelliteManagerTest, SatelliteManagerTestOnMockServiceTest
Change-Id: I8e094295870a98c7df1aa93142d4eb831ebff98d
parent 4fcbdd9d

core/api/system-current.txt

+2 −2
Original line number Diff line number Diff line
@@ -16983,7 +16983,7 @@ package android.telephony.satellite { 
    method @FlaggedApi("com.android.internal.telephony.flags.carrier_enabled_satellite_flag") @NonNull @RequiresPermission(android.Manifest.permission.SATELLITE_COMMUNICATION) public java.util.Set<java.lang.Integer> getSatelliteAttachRestrictionReasonsForCarrier(int);

    method @FlaggedApi("com.android.internal.telephony.flags.oem_enabled_satellite_flag") @RequiresPermission(android.Manifest.permission.SATELLITE_COMMUNICATION) public void pollPendingSatelliteDatagrams(@NonNull java.util.concurrent.Executor, @NonNull java.util.function.Consumer<java.lang.Integer>);

    method @FlaggedApi("com.android.internal.telephony.flags.oem_enabled_satellite_flag") @RequiresPermission(android.Manifest.permission.SATELLITE_COMMUNICATION) public void provisionSatelliteService(@NonNull String, @NonNull byte[], @Nullable android.os.CancellationSignal, @NonNull java.util.concurrent.Executor, @NonNull java.util.function.Consumer<java.lang.Integer>);

    method @FlaggedApi("com.android.internal.telephony.flags.oem_enabled_satellite_flag") @RequiresPermission(android.Manifest.permission.SATELLITE_COMMUNICATION) public int registerForNtnSignalStrengthChanged(@NonNull java.util.concurrent.Executor, @NonNull android.telephony.satellite.NtnSignalStrengthCallback);

    method @FlaggedApi("com.android.internal.telephony.flags.oem_enabled_satellite_flag") @RequiresPermission(android.Manifest.permission.SATELLITE_COMMUNICATION) public void registerForNtnSignalStrengthChanged(@NonNull java.util.concurrent.Executor, @NonNull android.telephony.satellite.NtnSignalStrengthCallback) throws android.telephony.satellite.SatelliteManager.SatelliteException;

    method @FlaggedApi("com.android.internal.telephony.flags.oem_enabled_satellite_flag") @RequiresPermission(android.Manifest.permission.SATELLITE_COMMUNICATION) public int registerForSatelliteCapabilitiesChanged(@NonNull java.util.concurrent.Executor, @NonNull android.telephony.satellite.SatelliteCapabilitiesCallback);

    method @FlaggedApi("com.android.internal.telephony.flags.oem_enabled_satellite_flag") @RequiresPermission(android.Manifest.permission.SATELLITE_COMMUNICATION) public int registerForSatelliteDatagram(@NonNull java.util.concurrent.Executor, @NonNull android.telephony.satellite.SatelliteDatagramCallback);

    method @FlaggedApi("com.android.internal.telephony.flags.oem_enabled_satellite_flag") @RequiresPermission(android.Manifest.permission.SATELLITE_COMMUNICATION) public int registerForSatelliteModemStateChanged(@NonNull java.util.concurrent.Executor, @NonNull android.telephony.satellite.SatelliteStateCallback);
@@ -16995,7 +16995,7 @@ package android.telephony.satellite { 
    method @FlaggedApi("com.android.internal.telephony.flags.oem_enabled_satellite_flag") @RequiresPermission(android.Manifest.permission.SATELLITE_COMMUNICATION) public void requestIsSatelliteEnabled(@NonNull java.util.concurrent.Executor, @NonNull android.os.OutcomeReceiver<java.lang.Boolean,android.telephony.satellite.SatelliteManager.SatelliteException>);

    method @FlaggedApi("com.android.internal.telephony.flags.oem_enabled_satellite_flag") @RequiresPermission(android.Manifest.permission.SATELLITE_COMMUNICATION) public void requestIsSatelliteProvisioned(@NonNull java.util.concurrent.Executor, @NonNull android.os.OutcomeReceiver<java.lang.Boolean,android.telephony.satellite.SatelliteManager.SatelliteException>);

    method @FlaggedApi("com.android.internal.telephony.flags.oem_enabled_satellite_flag") public void requestIsSatelliteSupported(@NonNull java.util.concurrent.Executor, @NonNull android.os.OutcomeReceiver<java.lang.Boolean,android.telephony.satellite.SatelliteManager.SatelliteException>);

    method @FlaggedApi("com.android.internal.telephony.flags.oem_enabled_satellite_flag") @NonNull @RequiresPermission(android.Manifest.permission.SATELLITE_COMMUNICATION) public void requestNtnSignalStrength(@NonNull java.util.concurrent.Executor, @NonNull android.os.OutcomeReceiver<android.telephony.satellite.NtnSignalStrength,android.telephony.satellite.SatelliteManager.SatelliteException>);

    method @FlaggedApi("com.android.internal.telephony.flags.oem_enabled_satellite_flag") @RequiresPermission(android.Manifest.permission.SATELLITE_COMMUNICATION) public void requestNtnSignalStrength(@NonNull java.util.concurrent.Executor, @NonNull android.os.OutcomeReceiver<android.telephony.satellite.NtnSignalStrength,android.telephony.satellite.SatelliteManager.SatelliteException>);

    method @FlaggedApi("com.android.internal.telephony.flags.carrier_enabled_satellite_flag") @RequiresPermission(android.Manifest.permission.SATELLITE_COMMUNICATION) public void requestSatelliteAttachEnabledForCarrier(int, boolean, @NonNull java.util.concurrent.Executor, @NonNull java.util.function.Consumer<java.lang.Integer>);

    method @FlaggedApi("com.android.internal.telephony.flags.oem_enabled_satellite_flag") @RequiresPermission(android.Manifest.permission.SATELLITE_COMMUNICATION) public void requestSatelliteCapabilities(@NonNull java.util.concurrent.Executor, @NonNull android.os.OutcomeReceiver<android.telephony.satellite.SatelliteCapabilities,android.telephony.satellite.SatelliteManager.SatelliteException>);

    method @FlaggedApi("com.android.internal.telephony.flags.oem_enabled_satellite_flag") @RequiresPermission(android.Manifest.permission.SATELLITE_COMMUNICATION) public void requestSatelliteEnabled(boolean, boolean, @NonNull java.util.concurrent.Executor, @NonNull java.util.function.Consumer<java.lang.Integer>);

telephony/java/android/telephony/satellite/NtnSignalStrength.java

+3 −0
Original line number Diff line number Diff line
@@ -86,6 +86,9 @@ public final class NtnSignalStrength implements Parcelable { 
        readFromParcel(in);

    }



    /**

     * Returns notified non-terrestrial network signal strength level.

     */

    @FlaggedApi(Flags.FLAG_OEM_ENABLED_SATELLITE_FLAG)

    @NtnSignalStrengthLevel public int getLevel() {

        return mLevel;

telephony/java/android/telephony/satellite/SatelliteManager.java

+13 −8
Original line number Diff line number Diff line
@@ -34,6 +34,7 @@ import android.os.ICancellationSignal; 
import android.os.OutcomeReceiver;

import android.os.RemoteException;

import android.os.ResultReceiver;

import android.os.ServiceSpecificException;

import android.telephony.SubscriptionManager;

import android.telephony.TelephonyCallback;

import android.telephony.TelephonyFrameworkInitializer;
@@ -1919,7 +1920,6 @@ public final class SatelliteManager { 
     */

    @RequiresPermission(Manifest.permission.SATELLITE_COMMUNICATION)

    @FlaggedApi(Flags.FLAG_OEM_ENABLED_SATELLITE_FLAG)

    @NonNull

    public void requestNtnSignalStrength(@NonNull @CallbackExecutor Executor executor,

            @NonNull OutcomeReceiver<NtnSignalStrength, SatelliteException> callback) {

        Objects.requireNonNull(executor);
@@ -1962,6 +1962,8 @@ public final class SatelliteManager { 


    /**

     * Registers for NTN signal strength changed from satellite modem.

     * If the registration operation is not successful, a {@link SatelliteException} that contains

     * {@link SatelliteResult} will be thrown.

     *

     * <p>

     * Note: This API is specifically designed for OEM enabled satellite connectivity only.
@@ -1973,16 +1975,14 @@ public final class SatelliteManager { 
     * @param executor The executor on which the callback will be called.

     * @param callback The callback to handle the NTN signal strength changed event.

     *

     * @return The {@link SatelliteResult} result of the operation.

     *

     * @throws SecurityException if the caller doesn't have required permission.

     * @throws IllegalStateException if the Telephony process is not currently available.

     * @throws SatelliteException if the callback registration operation fails.

     */

    @RequiresPermission(Manifest.permission.SATELLITE_COMMUNICATION)

    @FlaggedApi(Flags.FLAG_OEM_ENABLED_SATELLITE_FLAG)

    @SatelliteResult public int registerForNtnSignalStrengthChanged(

            @NonNull @CallbackExecutor Executor executor,

            @NonNull NtnSignalStrengthCallback callback) {

    public void registerForNtnSignalStrengthChanged(@NonNull @CallbackExecutor Executor executor,

            @NonNull NtnSignalStrengthCallback callback) throws SatelliteException {

        Objects.requireNonNull(executor);

        Objects.requireNonNull(callback);
@@ -1999,16 +1999,18 @@ public final class SatelliteManager { 
                                                ntnSignalStrength)));

                            }

                        };

                telephony.registerForNtnSignalStrengthChanged(mSubId, internalCallback);

                sNtnSignalStrengthCallbackMap.put(callback, internalCallback);

                return telephony.registerForNtnSignalStrengthChanged(mSubId, internalCallback);

            } else {

                throw new IllegalStateException("Telephony service is null.");

            }

        } catch (ServiceSpecificException ex) {

            logd("registerForNtnSignalStrengthChanged() registration fails: " + ex.errorCode);

            throw new SatelliteException(ex.errorCode);

        } catch (RemoteException ex) {

            loge("registerForNtnSignalStrengthChanged() RemoteException: " + ex);

            ex.rethrowFromSystemServer();

        }

        return SATELLITE_RESULT_REQUEST_FAILED;

    }



    /**
@@ -2025,6 +2027,8 @@ public final class SatelliteManager { 
     * {@link #registerForNtnSignalStrengthChanged(Executor, NtnSignalStrengthCallback)}.

     *

     * @throws SecurityException if the caller doesn't have required permission.

     * @throws IllegalArgumentException if the callback is not valid or has already been

     * unregistered.

     * @throws IllegalStateException if the Telephony process is not currently available.

     */

    @RequiresPermission(Manifest.permission.SATELLITE_COMMUNICATION)
@@ -2041,6 +2045,7 @@ public final class SatelliteManager { 
                    telephony.unregisterForNtnSignalStrengthChanged(mSubId, internalCallback);

                } else {

                    loge("unregisterForNtnSignalStrengthChanged: No internal callback.");

                    throw new IllegalArgumentException("callback is not valid");

                }

            } else {

                throw new IllegalStateException("Telephony service is null.");

telephony/java/com/android/internal/telephony/ITelephony.aidl

+10 −5
Original line number Diff line number Diff line
@@ -3101,16 +3101,21 @@ interface ITelephony { 
    void requestNtnSignalStrength(int subId, in ResultReceiver receiver);



    /**

     * Registers for NTN signal strength changed from satellite modem.

     * Registers for NTN signal strength changed from satellite modem. If the registration operation

     * is not successful, a {@link SatelliteException} that contains {@link SatelliteResult} will be

     * thrown.

     *

     * @param subId The subId of the subscription to request for.

     * @param callback The callback to handle the NTN signal strength changed event.

     *

     * @return The {@link SatelliteResult} result of the operation.

     * @param callback The callback to handle the NTN signal strength changed event. If the

     * operation is successful, {@link NtnSignalStrengthCallback#onNtnSignalStrengthChanged(

     * NtnSignalStrength)} will return an instance of {@link NtnSignalStrength} with a value of

     * {@link NtnSignalStrength.NtnSignalStrengthLevel} when the signal strength of non-terrestrial

     * network has changed.

     */

    @JavaPassthrough(annotation="@android.annotation.RequiresPermission("

            + "android.Manifest.permission.SATELLITE_COMMUNICATION)")

    int registerForNtnSignalStrengthChanged(int subId, in INtnSignalStrengthCallback callback);

    void registerForNtnSignalStrengthChanged(int subId,

            in INtnSignalStrengthCallback callback);



    /**

     * Unregisters for NTN signal strength changed from satellite modem.