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

Commit 2b14af22 authored by Nathan Harold's avatar Nathan Harold
Browse files

Return the RPLMN from NetworkRegistrationInfo 

Add an API to get the RPLMN in network registration info.

This PLMN-ID is the one chosen from the PLMN IDs broadcast
by the cell for registration purposes.

Bug: 135921133
Test: make update-api && make offline-sdk-docs && make
      && atest FrameworksTelephonyTests
Change-Id: I82f9150e185d9809572d246b57ea42f14ad64f15
parent 6923cdd8

api/current.txt

+1 −0
Original line number Diff line number Diff line
@@ -47074,6 +47074,7 @@ package android.telephony { 
    method @Nullable public android.telephony.CellIdentity getCellIdentity();

    method public int getDomain();

    method public int getNrState();

    method @NonNull public String getRegisteredPlmn();

    method public int getTransportType();

    method public boolean isRegistered();

    method public boolean isRoaming();

api/system-current.txt

+1 −0
Original line number Diff line number Diff line
@@ -11726,6 +11726,7 @@ package android.telephony { 
    method @NonNull public android.telephony.NetworkRegistrationInfo.Builder setCellIdentity(@Nullable android.telephony.CellIdentity);

    method @NonNull public android.telephony.NetworkRegistrationInfo.Builder setDomain(int);

    method @NonNull public android.telephony.NetworkRegistrationInfo.Builder setEmergencyOnly(boolean);

    method @NonNull public android.telephony.NetworkRegistrationInfo.Builder setRegisteredPlmn(@Nullable String);

    method @NonNull public android.telephony.NetworkRegistrationInfo.Builder setRegistrationState(int);

    method @NonNull public android.telephony.NetworkRegistrationInfo.Builder setRejectCause(int);

    method @NonNull public android.telephony.NetworkRegistrationInfo.Builder setTransportType(int);

api/test-current.txt

+1 −0
Original line number Diff line number Diff line
@@ -3475,6 +3475,7 @@ package android.telephony { 
    method @NonNull public android.telephony.NetworkRegistrationInfo.Builder setCellIdentity(@Nullable android.telephony.CellIdentity);

    method @NonNull public android.telephony.NetworkRegistrationInfo.Builder setDomain(int);

    method @NonNull public android.telephony.NetworkRegistrationInfo.Builder setEmergencyOnly(boolean);

    method @NonNull public android.telephony.NetworkRegistrationInfo.Builder setRegisteredPlmn(@Nullable String);

    method @NonNull public android.telephony.NetworkRegistrationInfo.Builder setRegistrationState(int);

    method @NonNull public android.telephony.NetworkRegistrationInfo.Builder setRejectCause(int);

    method @NonNull public android.telephony.NetworkRegistrationInfo.Builder setTransportType(int);

telephony/java/android/telephony/NetworkRegistrationInfo.java

+52 −10
Original line number Diff line number Diff line
@@ -25,6 +25,7 @@ import android.os.Parcel; 
import android.os.Parcelable;

import android.telephony.AccessNetworkConstants.TransportType;

import android.telephony.Annotation.NetworkType;

import android.text.TextUtils;



import java.lang.annotation.Retention;

import java.lang.annotation.RetentionPolicy;
@@ -214,6 +215,9 @@ public final class NetworkRegistrationInfo implements Parcelable { 
    @Nullable

    private DataSpecificRegistrationInfo mDataSpecificInfo;



    @NonNull

    private String mRplmn;



    /**

     * @param domain Network domain. Must be a {@link Domain}. For transport type

     * {@link AccessNetworkConstants#TRANSPORT_TYPE_WLAN}, this must set to {@link #DOMAIN_PS}.
@@ -234,13 +238,14 @@ public final class NetworkRegistrationInfo implements Parcelable { 
     * @param availableServices The list of the supported services.

     * @param cellIdentity The identity representing a unique cell or wifi AP. Set to null if the

     * information is not available.

     * @param rplmn the registered plmn or the last plmn for attempted registration if reg failed.

     */

    private NetworkRegistrationInfo(@Domain int domain, @TransportType int transportType,

                                   @RegistrationState int registrationState,

                                   @NetworkType int accessNetworkTechnology, int rejectCause,

                                   boolean emergencyOnly,

                                   @Nullable @ServiceType List<Integer> availableServices,

                                   @Nullable CellIdentity cellIdentity) {

                                   @Nullable CellIdentity cellIdentity, @Nullable String rplmn) {

        mDomain = domain;

        mTransportType = transportType;

        mRegistrationState = registrationState;
@@ -253,6 +258,7 @@ public final class NetworkRegistrationInfo implements Parcelable { 
        mCellIdentity = cellIdentity;

        mEmergencyOnly = emergencyOnly;

        mNrState = NR_STATE_NONE;

        mRplmn = (rplmn == null) ? "" : rplmn;

    }



    /**
@@ -263,11 +269,11 @@ public final class NetworkRegistrationInfo implements Parcelable { 
                                   int registrationState, int accessNetworkTechnology,

                                   int rejectCause, boolean emergencyOnly,

                                   @Nullable List<Integer> availableServices,

                                   @Nullable CellIdentity cellIdentity, boolean cssSupported,

                                   int roamingIndicator, int systemIsInPrl,

                                   @Nullable CellIdentity cellIdentity, @Nullable String rplmn,

                                   boolean cssSupported, int roamingIndicator, int systemIsInPrl,

                                   int defaultRoamingIndicator) {

        this(domain, transportType, registrationState, accessNetworkTechnology, rejectCause,

                emergencyOnly, availableServices, cellIdentity);

                emergencyOnly, availableServices, cellIdentity, rplmn);



        mVoiceSpecificInfo = new VoiceSpecificRegistrationInfo(cssSupported, roamingIndicator,

                systemIsInPrl, defaultRoamingIndicator);
@@ -281,13 +287,13 @@ public final class NetworkRegistrationInfo implements Parcelable { 
                                   int registrationState, int accessNetworkTechnology,

                                   int rejectCause, boolean emergencyOnly,

                                   @Nullable List<Integer> availableServices,

                                   @Nullable CellIdentity cellIdentity, int maxDataCalls,

                                   boolean isDcNrRestricted, boolean isNrAvailable,

                                   boolean isEndcAvailable,

                                   @Nullable CellIdentity cellIdentity, @Nullable String rplmn,

                                   int maxDataCalls, boolean isDcNrRestricted,

                                   boolean isNrAvailable, boolean isEndcAvailable,

                                   LteVopsSupportInfo lteVopsSupportInfo,

                                   boolean isUsingCarrierAggregation) {

        this(domain, transportType, registrationState, accessNetworkTechnology, rejectCause,

                emergencyOnly, availableServices, cellIdentity);

                emergencyOnly, availableServices, cellIdentity, rplmn);

        mDataSpecificInfo = new DataSpecificRegistrationInfo(

                maxDataCalls, isDcNrRestricted, isNrAvailable, isEndcAvailable, lteVopsSupportInfo,

                isUsingCarrierAggregation);
@@ -310,6 +316,7 @@ public final class NetworkRegistrationInfo implements Parcelable { 
        mDataSpecificInfo = source.readParcelable(

                DataSpecificRegistrationInfo.class.getClassLoader());

        mNrState = source.readInt();

        mRplmn = source.readString();

    }



    /**
@@ -343,6 +350,7 @@ public final class NetworkRegistrationInfo implements Parcelable { 
            mDataSpecificInfo = new DataSpecificRegistrationInfo(nri.mDataSpecificInfo);

        }

        mNrState = nri.mNrState;

        mRplmn = nri.mRplmn;

    }



    /**
@@ -394,6 +402,22 @@ public final class NetworkRegistrationInfo implements Parcelable { 
        return mRegistrationState == REGISTRATION_STATE_NOT_REGISTERED_SEARCHING;

    }



    /**

     * Get the PLMN-ID for this Network Registration, also known as the RPLMN.

     *

     * <p>If the device is registered, this will return the registered PLMN-ID. If registration

     * has failed, then this will return the PLMN ID of the last attempted registration. If the

     * device is not registered, or if is registered to a non-3GPP radio technology, then this

     * will return an empty string.

     *

     * <p>See 3GPP TS 23.122 for further information about the Registered PLMN.

     *

     * @return the registered PLMN-ID or an empty string.

     */

    @NonNull public String getRegisteredPlmn() {

        return mRplmn;

    }



    /**

     * @return {@code true} if registered on roaming network, {@code false} otherwise.

     */
@@ -590,6 +614,7 @@ public final class NetworkRegistrationInfo implements Parcelable { 
                .append(" voiceSpecificInfo=").append(mVoiceSpecificInfo)

                .append(" dataSpecificInfo=").append(mDataSpecificInfo)

                .append(" nrState=").append(nrStateToString(mNrState))

                .append(" rRplmn=").append(mRplmn)

                .append("}").toString();

    }
@@ -597,7 +622,7 @@ public final class NetworkRegistrationInfo implements Parcelable { 
    public int hashCode() {

        return Objects.hash(mDomain, mTransportType, mRegistrationState, mRoamingType,

                mAccessNetworkTechnology, mRejectCause, mEmergencyOnly, mAvailableServices,

                mCellIdentity, mVoiceSpecificInfo, mDataSpecificInfo, mNrState);

                mCellIdentity, mVoiceSpecificInfo, mDataSpecificInfo, mNrState, mRplmn);

    }



    @Override
@@ -620,6 +645,7 @@ public final class NetworkRegistrationInfo implements Parcelable { 
                && Objects.equals(mCellIdentity, other.mCellIdentity)

                && Objects.equals(mVoiceSpecificInfo, other.mVoiceSpecificInfo)

                && Objects.equals(mDataSpecificInfo, other.mDataSpecificInfo)

                && TextUtils.equals(mRplmn, other.mRplmn)

                && mNrState == other.mNrState;

    }
@@ -641,6 +667,7 @@ public final class NetworkRegistrationInfo implements Parcelable { 
        dest.writeParcelable(mVoiceSpecificInfo, 0);

        dest.writeParcelable(mDataSpecificInfo, 0);

        dest.writeInt(mNrState);

        dest.writeString(mRplmn);

    }



    /**
@@ -741,6 +768,9 @@ public final class NetworkRegistrationInfo implements Parcelable { 
        @Nullable

        private CellIdentity mCellIdentity;



        @NonNull

        private String mRplmn = "";



        /**

         * Default constructor for Builder.

         */
@@ -854,6 +884,18 @@ public final class NetworkRegistrationInfo implements Parcelable { 
            return this;

        }



        /**

         * Set the registered PLMN.

         *

         * @param rplmn the registered plmn.

         *

         * @return The same instance of the builder.

         */

        public @NonNull Builder setRegisteredPlmn(@Nullable String rplmn) {

            mRplmn = (rplmn == null) ? "" : rplmn;

            return this;

        }



        /**

         * Build the NetworkRegistrationInfo.

         * @return the NetworkRegistrationInfo object.
@@ -863,7 +905,7 @@ public final class NetworkRegistrationInfo implements Parcelable { 
        public @NonNull NetworkRegistrationInfo build() {

            return new NetworkRegistrationInfo(mDomain, mTransportType, mRegistrationState,

                    mAccessNetworkTechnology, mRejectCause, mEmergencyOnly, mAvailableServices,

                    mCellIdentity);

                    mCellIdentity, mRplmn);

        }

    }

}