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

Commit 1a225544 authored by joonhunshin's avatar joonhunshin Committed by Joonhun Shin
Browse files

Enforce map the telephony features with APIs in SubscriptionManager 

Add @RerequiredFeature.
Add comment the interface throws UnsupportedOperationException when the required feature was not defined.

Bug: 297989574
Test: atest SubscriptionManagerTest
Change-Id: If910961a321ff45720fb949cac0254948355fb00
parent f1cb2e98

telephony/java/android/telephony/SubscriptionManager.java

+110 −0
Original line number Diff line number Diff line
@@ -1667,6 +1667,9 @@ public class SubscriptionManager { 
     *

     * @param subId The unique SubscriptionInfo key in database.

     * @return SubscriptionInfo, maybe null if its not active.

     *

     * @throws UnsupportedOperationException If the device does not have

     *          {@link PackageManager#FEATURE_TELEPHONY_SUBSCRIPTION}.

     */

    @SuppressAutoDoc // Blocked by b/72967236 - no support for carrier privileges

    @RequiresPermission(android.Manifest.permission.READ_PHONE_STATE)
@@ -1700,6 +1703,8 @@ public class SubscriptionManager { 
     * @param iccId the IccId of SIM card

     * @return SubscriptionInfo, maybe null if its not active

     *

     * @throws UnsupportedOperationException If the device does not have

     *          {@link PackageManager#FEATURE_TELEPHONY_SUBSCRIPTION}.

     * @hide

     */

    @RequiresPermission(android.Manifest.permission.READ_PRIVILEGED_PHONE_STATE)
@@ -1736,6 +1741,9 @@ public class SubscriptionManager { 
     *

     * @param slotIndex the slot which the subscription is inserted

     * @return SubscriptionInfo, maybe null if its not active

     *

     * @throws UnsupportedOperationException If the device does not have

     *          {@link PackageManager#FEATURE_TELEPHONY_SUBSCRIPTION}.

     */

    @SuppressAutoDoc // Blocked by b/72967236 - no support for carrier privileges

    @RequiresPermission(android.Manifest.permission.READ_PHONE_STATE)
@@ -1780,6 +1788,8 @@ public class SubscriptionManager { 
     * {@link SubscriptionInfo#getSubscriptionId()}.

     *

     * @throws SecurityException if callers do not hold the required permission.

     * @throws UnsupportedOperationException If the device does not have

     *          {@link PackageManager#FEATURE_TELEPHONY_SUBSCRIPTION}.

     */

    @NonNull

    @RequiresPermission(anyOf = {
@@ -1839,6 +1849,9 @@ public class SubscriptionManager { 
     * then by {@link SubscriptionInfo#getSubscriptionId}.

     * </li>

     * </ul>

     *

     * @throws UnsupportedOperationException If the device does not have

     *          {@link PackageManager#FEATURE_TELEPHONY_SUBSCRIPTION}.

     */

    @RequiresPermission(android.Manifest.permission.READ_PHONE_STATE)

    // @RequiresPermission(TODO(b/308809058))
@@ -1882,6 +1895,8 @@ public class SubscriptionManager { 
     * This is similar to {@link #getActiveSubscriptionInfoList} except that it will return

     * both active and hidden SubscriptionInfos.

     *

     * @throws UnsupportedOperationException If the device does not have

     *          {@link PackageManager#FEATURE_TELEPHONY_SUBSCRIPTION}.

     */

    public @NonNull List<SubscriptionInfo> getCompleteActiveSubscriptionInfoList() {

        List<SubscriptionInfo> completeList = getActiveSubscriptionInfoList(
@@ -1966,6 +1981,9 @@ public class SubscriptionManager { 
     * <p>

     * Permissions android.Manifest.permission.READ_PRIVILEGED_PHONE_STATE is required

     * for #getAvailableSubscriptionInfoList to be invoked.

     *

     * @throws UnsupportedOperationException If the device does not have

     *          {@link PackageManager#FEATURE_TELEPHONY_SUBSCRIPTION}.

     * @hide

     */

    @SystemApi
@@ -2007,6 +2025,9 @@ public class SubscriptionManager { 
     * if the list is non-empty the list is sorted by {@link SubscriptionInfo#getSimSlotIndex}

     * then by {@link SubscriptionInfo#getSubscriptionId}.

     * </ul>

     *

     * @throws UnsupportedOperationException If the device does not have

     *          {@link PackageManager#FEATURE_TELEPHONY_EUICC}.

     */

    public List<SubscriptionInfo> getAccessibleSubscriptionInfoList() {

        List<SubscriptionInfo> result = null;
@@ -2035,6 +2056,8 @@ public class SubscriptionManager { 
     *

     * @see TelephonyManager#getCardIdForDefaultEuicc() for more information on the card ID.

     *

     * @throws UnsupportedOperationException If the device does not have

     *          {@link PackageManager#FEATURE_TELEPHONY_EUICC}.

     * @hide

     */

    @SystemApi
@@ -2065,6 +2088,8 @@ public class SubscriptionManager { 
     *

     * @see TelephonyManager#getCardIdForDefaultEuicc() for more information on the card ID.

     *

     * @throws UnsupportedOperationException If the device does not have

     *          {@link PackageManager#FEATURE_TELEPHONY_EUICC}.

     * @hide

     */

    @SystemApi
@@ -2087,6 +2112,9 @@ public class SubscriptionManager { 
     * @return The current number of active subscriptions.

     *

     * @see #getActiveSubscriptionInfoList()

     *

     * @throws UnsupportedOperationException If the device does not have

     *          {@link PackageManager#FEATURE_TELEPHONY_SUBSCRIPTION}.

     */

    @RequiresPermission(android.Manifest.permission.READ_PHONE_STATE)

    // @RequiresPermission(TODO(b/308809058))
@@ -2157,6 +2185,9 @@ public class SubscriptionManager { 
     * @param slotIndex the slot assigned to this subscription. It is ignored for subscriptionType

     *                  of {@link #SUBSCRIPTION_TYPE_REMOTE_SIM}.

     * @param subscriptionType the {@link #SUBSCRIPTION_TYPE}

     *

     * @throws UnsupportedOperationException If the device does not have

     *          {@link PackageManager#FEATURE_TELEPHONY_SUBSCRIPTION}.

     * @hide

     */

    @SystemApi(client = SystemApi.Client.MODULE_LIBRARIES)
@@ -2199,6 +2230,8 @@ public class SubscriptionManager { 
     * @throws NullPointerException if {@code uniqueId} is {@code null}.

     * @throws SecurityException if callers do not hold the required permission.

     *

     * @throws UnsupportedOperationException If the device does not have

     *          {@link PackageManager#FEATURE_TELEPHONY_SUBSCRIPTION}.

     * @hide

     */

    @SystemApi(client = SystemApi.Client.MODULE_LIBRARIES)
@@ -2345,6 +2378,7 @@ public class SubscriptionManager { 
     * @deprecated Use {@link #getSubscriptionId(int)} instead.

     * @hide

     */

    @Deprecated

    public static int[] getSubId(int slotIndex) {

        if (!isValidSlotIndex(slotIndex)) {

            return null;
@@ -2399,6 +2433,9 @@ public class SubscriptionManager { 
     * On a data only device or on error, will return INVALID_SUBSCRIPTION_ID.

     *

     * @return the default voice subscription Id.

     *

     * @throws UnsupportedOperationException If the device does not have

     *          {@link PackageManager#FEATURE_TELEPHONY_SUBSCRIPTION}.

     */

    public static int getDefaultVoiceSubscriptionId() {

        int subId = INVALID_SUBSCRIPTION_ID;
@@ -2426,6 +2463,9 @@ public class SubscriptionManager { 
     *

     * @param subscriptionId A valid subscription ID to set as the system default, or

     *                       {@link SubscriptionManager#INVALID_SUBSCRIPTION_ID}

     *

     * @throws UnsupportedOperationException If the device does not have

     *          {@link PackageManager#FEATURE_TELEPHONY_SUBSCRIPTION}.

     * @hide

     */

    @SystemApi
@@ -2445,6 +2485,9 @@ public class SubscriptionManager { 
    /**

     * Same as {@link #setDefaultVoiceSubscriptionId(int)}, but preserved for backwards

     * compatibility.

     *

     * @throws UnsupportedOperationException If the device does not have

     *          {@link PackageManager#FEATURE_TELEPHONY_SUBSCRIPTION}.

     * @hide

     */

    public void setDefaultVoiceSubId(int subId) {
@@ -2488,6 +2531,8 @@ public class SubscriptionManager { 
     *

     * @param subscriptionId the supplied subscription ID

     *

     * @throws UnsupportedOperationException If the device does not have

     *          {@link PackageManager#FEATURE_TELEPHONY_SUBSCRIPTION}.

     * @hide

     */

    @SystemApi
@@ -2522,6 +2567,8 @@ public class SubscriptionManager { 
     *

     * @param subscriptionId the supplied subscription ID

     *

     * @throws UnsupportedOperationException If the device does not have

     *          {@link PackageManager#FEATURE_TELEPHONY_SUBSCRIPTION}.

     * @hide

     */

    @SystemApi
@@ -2544,6 +2591,9 @@ public class SubscriptionManager { 
     * Will return null on voice only devices, or on error.

     *

     * @return the SubscriptionInfo for the default data subscription.

     *

     * @throws UnsupportedOperationException If the device does not have

     *          {@link PackageManager#FEATURE_TELEPHONY_SUBSCRIPTION}.

     * @hide

     */

    @UnsupportedAppUsage
@@ -2630,6 +2680,9 @@ public class SubscriptionManager { 
     *

     * @return the list of subId's that are active,

     *         is never null but the length may be 0.

     *

     * @throws UnsupportedOperationException If the device does not have

     *          {@link PackageManager#FEATURE_TELEPHONY_SUBSCRIPTION}.

     * @hide

     */

    @SystemApi
@@ -2648,6 +2701,9 @@ public class SubscriptionManager { 
     *

     * @return the list of subId's that are active,

     *         is never null but the length may be 0.

     *

     * @throws UnsupportedOperationException If the device does not have

     *          {@link PackageManager#FEATURE_TELEPHONY_SUBSCRIPTION}.

     * @hide

     */

    @SystemApi
@@ -2897,6 +2953,9 @@ public class SubscriptionManager { 
     * @param context Context object

     * @param subId Subscription Id of Subscription whose resources are required

     * @return Resources associated with Subscription.

     *

     * @throws UnsupportedOperationException If the device does not have

     *          {@link PackageManager#FEATURE_TELEPHONY_SUBSCRIPTION}.

     * @hide

     */

    @NonNull
@@ -2979,6 +3038,9 @@ public class SubscriptionManager { 
     * @return {@code true} if the supplied subscription ID corresponds to an active subscription;

     * {@code false} if it does not correspond to an active subscription; or throw a

     * SecurityException if the caller hasn't got the right permission.

     *i

     * @throws UnsupportedOperationException If the device does not have

     *          {@link PackageManager#FEATURE_TELEPHONY_SUBSCRIPTION}.

     */

    @RequiresPermission(android.Manifest.permission.READ_PHONE_STATE)

    public boolean isActiveSubscriptionId(int subscriptionId) {
@@ -3287,6 +3349,8 @@ public class SubscriptionManager { 
     *

     * @throws IllegalStateException when subscription manager service is not available.

     * @throws SecurityException when clients do not have MODIFY_PHONE_STATE permission.

     * @throws UnsupportedOperationException If the device does not have

     *          {@link PackageManager#FEATURE_TELEPHONY_SUBSCRIPTION}.

     * @hide

     */

    @SystemApi
@@ -3364,6 +3428,9 @@ public class SubscriptionManager { 
     * {@link TelephonyManager#hasCarrierPrivileges}).

     *

     * @return the list of opportunistic subscription info. If none exists, an empty list.

     *

     * @throws UnsupportedOperationException If the device does not have

     *          {@link PackageManager#FEATURE_TELEPHONY_SUBSCRIPTION}.

     */

    @SuppressAutoDoc // Blocked by b/72967236 - no support for carrier privileges

    @RequiresPermission(android.Manifest.permission.READ_PHONE_STATE)
@@ -3399,8 +3466,12 @@ public class SubscriptionManager { 
     *  PendingIntent)} and does not support Multiple Enabled Profile(MEP). Apps should use

     *  {@link EuiccManager#switchToSubscription(int, PendingIntent)} or

     *  {@link EuiccManager#switchToSubscription(int, int, PendingIntent)} instead.

     *

     * @throws UnsupportedOperationException If the device does not have

     *          {@link PackageManager#FEATURE_TELEPHONY_EUICC}.

     */

    @RequiresPermission(android.Manifest.permission.WRITE_EMBEDDED_SUBSCRIPTIONS)

    @RequiresFeature(PackageManager.FEATURE_TELEPHONY_EUICC)

    @Deprecated

    public void switchToSubscription(int subId, @NonNull PendingIntent callbackIntent) {

        Preconditions.checkNotNull(callbackIntent, "callbackIntent cannot be null");
@@ -3428,6 +3499,9 @@ public class SubscriptionManager { 
     * @param opportunistic whether it’s opportunistic subscription.

     * @param subId the unique SubscriptionInfo index in database

     * @return {@code true} if the operation is succeed, {@code false} otherwise.

     *

     * @throws UnsupportedOperationException If the device does not have

     *          {@link PackageManager#FEATURE_TELEPHONY_SUBSCRIPTION}.

     */

    @SuppressAutoDoc // Blocked by b/72967236 - no support for carrier privileges

    @RequiresPermission(android.Manifest.permission.MODIFY_PHONE_STATE)
@@ -3464,6 +3538,8 @@ public class SubscriptionManager { 
     *             outlined above.

     * @throws IllegalArgumentException if any of the subscriptions in the list doesn't exist.

     * @throws IllegalStateException if Telephony service is in bad state.

     * @throws UnsupportedOperationException If the device does not have

     *          {@link PackageManager#FEATURE_TELEPHONY_SUBSCRIPTION}.

     *

     * @param subIdList list of subId that will be in the same group

     * @return groupUUID a UUID assigned to the subscription group.
@@ -3508,6 +3584,8 @@ public class SubscriptionManager { 
     *             outlined above.

     * @throws IllegalArgumentException if the some subscriptions in the list doesn't exist.

     * @throws IllegalStateException if Telephony service is in bad state.

     * @throws UnsupportedOperationException If the device does not have

     *          {@link PackageManager#FEATURE_TELEPHONY_SUBSCRIPTION}.

     *

     * @param subIdList list of subId that need adding into the group

     * @param groupUuid the groupUuid the subscriptions are being added to.
@@ -3557,6 +3635,8 @@ public class SubscriptionManager { 
     * @throws IllegalArgumentException if the some subscriptions in the list doesn't belong the

     * specified group.

     * @throws IllegalStateException if Telephony service is in bad state.

     * @throws UnsupportedOperationException If the device does not have

     *          {@link PackageManager#FEATURE_TELEPHONY_SUBSCRIPTION}.

     *

     * @see #createSubscriptionGroup(List)

     */
@@ -3606,6 +3686,8 @@ public class SubscriptionManager { 
     * @throws IllegalStateException if Telephony service is in bad state.

     * @throws SecurityException if the caller doesn't meet the requirements

     *             outlined above.

     * @throws UnsupportedOperationException If the device does not have

     *          {@link PackageManager#FEATURE_TELEPHONY_SUBSCRIPTION}.

     *

     * @param groupUuid of which list of subInfo will be returned.

     * @return list of subscriptionInfo that belong to the same group, including the given
@@ -3727,6 +3809,8 @@ public class SubscriptionManager { 
     *

     * @return whether the operation is successful.

     *

     * @throws UnsupportedOperationException If the device does not have

     *          {@link PackageManager#FEATURE_TELEPHONY_SUBSCRIPTION}.

     * @hide

     */

    @SystemApi
@@ -3754,6 +3838,9 @@ public class SubscriptionManager { 
     *

     * @param subscriptionId which subscription to operate on.

     * @param enabled whether uicc applications are enabled or disabled.

     *

     * @throws UnsupportedOperationException If the device does not have

     *          {@link PackageManager#FEATURE_TELEPHONY_SUBSCRIPTION}.

     * @hide

     */

    @SystemApi
@@ -3782,6 +3869,8 @@ public class SubscriptionManager { 
     *

     * @return whether can disable subscriptions on physical SIMs.

     *

     * @throws UnsupportedOperationException If the device does not have

     *          {@link PackageManager#FEATURE_TELEPHONY_SUBSCRIPTION}.

     * @hide

     */

    @SystemApi
@@ -3807,6 +3896,8 @@ public class SubscriptionManager { 
     *

     * @param subscriptionId The subscription id.

     *

     * @throws UnsupportedOperationException If the device does not have

     *          {@link PackageManager#FEATURE_TELEPHONY_SUBSCRIPTION}.

     * @hide

     */

    @SystemApi
@@ -3833,6 +3924,8 @@ public class SubscriptionManager { 
     * @param sharing The status sharing preference.

     *

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

     * @throws UnsupportedOperationException If the device does not have

     *          {@link PackageManager#FEATURE_TELEPHONY_SUBSCRIPTION}.

     */

    @RequiresPermission(Manifest.permission.MODIFY_PHONE_STATE)

    public void setDeviceToDeviceStatusSharingPreference(int subscriptionId,
@@ -3851,6 +3944,8 @@ public class SubscriptionManager { 
     * @return The device to device status sharing preference

     *

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

     * @throws UnsupportedOperationException If the device does not have

     *          {@link PackageManager#FEATURE_TELEPHONY_SUBSCRIPTION}.

     */

    public @DeviceToDeviceStatusSharingPreference int getDeviceToDeviceStatusSharingPreference(

            int subscriptionId) {
@@ -3870,6 +3965,8 @@ public class SubscriptionManager { 
     * @param contacts The list of contacts that allow device to device status sharing.

     *

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

     * @throws UnsupportedOperationException If the device does not have

     *          {@link PackageManager#FEATURE_TELEPHONY_SUBSCRIPTION}.

     */

    @RequiresPermission(Manifest.permission.MODIFY_PHONE_STATE)

    public void setDeviceToDeviceStatusSharingContacts(int subscriptionId,
@@ -3890,6 +3987,9 @@ public class SubscriptionManager { 
     * @param subscriptionId Subscription id.

     *

     * @return The list of contacts that allow device to device status sharing.

     *

     * @throws UnsupportedOperationException If the device does not have

     *          {@link PackageManager#FEATURE_TELEPHONY_SUBSCRIPTION}.

     */

    public @NonNull List<Uri> getDeviceToDeviceStatusSharingContacts(int subscriptionId) {

        String result = getStringSubscriptionProperty(mContext, subscriptionId,
@@ -3922,6 +4022,8 @@ public class SubscriptionManager { 
     *

     * @throws IllegalArgumentException if the provided slot index is invalid.

     * @throws SecurityException if callers do not hold the required permission.

     * @throws UnsupportedOperationException If the device does not have

     *          {@link PackageManager#FEATURE_TELEPHONY_SUBSCRIPTION}.

     *

     * @hide

     */
@@ -4062,6 +4164,8 @@ public class SubscriptionManager { 
     *

     * @param data with the sim specific configs to be backed up.

     *

     * @throws UnsupportedOperationException If the device does not have

     *          {@link PackageManager#FEATURE_TELEPHONY_SUBSCRIPTION}.

     * @hide

     */

    @SystemApi
@@ -4116,6 +4220,8 @@ public class SubscriptionManager { 
     * @throws IllegalArgumentException if {@code source} is invalid.

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

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

     * @throws UnsupportedOperationException If the device does not have

     *          {@link PackageManager#FEATURE_TELEPHONY_SUBSCRIPTION}.

     *

     * @see #PHONE_NUMBER_SOURCE_UICC

     * @see #PHONE_NUMBER_SOURCE_CARRIER
@@ -4176,6 +4282,8 @@ public class SubscriptionManager { 
     *

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

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

     * @throws UnsupportedOperationException If the device does not have

     *          {@link PackageManager#FEATURE_TELEPHONY_SUBSCRIPTION}.

     *

     * @see #getPhoneNumber(int, int)

     */
@@ -4219,6 +4327,8 @@ public class SubscriptionManager { 
     * @throws IllegalStateException if the telephony process is not currently available.

     * @throws NullPointerException if {@code number} is {@code null}.

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

     * @throws UnsupportedOperationException If the device does not have

     *          {@link PackageManager#FEATURE_TELEPHONY_SUBSCRIPTION}.

     */

    @RequiresPermission("carrier privileges")

    public void setCarrierPhoneNumber(int subscriptionId, @NonNull String number) {