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

Commit 1161a591 authored by Yan Yan's avatar Yan Yan
Browse files

Update setter/getters to configure underlying network priority 

- Update setters for configuring meteredness, roaming and
  opportunistic to take an int instead of a boolean
- Update NetworkPriorityClassifier and tests accordingly

Bug: 206044122
Test: atest FrameworksVcnTests, CtsVcnTestCases
Change-Id: I92bd2831cc42d634d73b842c42d18fa93a4ed46c
parent a9eec89e

core/java/android/net/vcn/VcnCellUnderlyingNetworkTemplate.java

+152 −79
Original line number Diff line number Diff line
@@ -15,6 +15,9 @@ 
 */

package android.net.vcn;



import static android.net.vcn.VcnUnderlyingNetworkTemplate.MATCH_ANY;

import static android.net.vcn.VcnUnderlyingNetworkTemplate.getMatchCriteriaString;



import static com.android.internal.annotations.VisibleForTesting.Visibility;

import static com.android.server.vcn.util.PersistableBundleUtils.INTEGER_DESERIALIZER;

import static com.android.server.vcn.util.PersistableBundleUtils.INTEGER_SERIALIZER;
@@ -23,8 +26,12 @@ import static com.android.server.vcn.util.PersistableBundleUtils.STRING_SERIALIZ 


import android.annotation.NonNull;

import android.annotation.Nullable;

import android.annotation.SuppressLint;

import android.net.NetworkCapabilities;

import android.net.vcn.VcnUnderlyingNetworkTemplate.MatchCriteria;

import android.os.PersistableBundle;

import android.telephony.SubscriptionInfo;

import android.telephony.SubscriptionManager;

import android.telephony.TelephonyManager;

import android.util.ArraySet;
@@ -37,32 +44,38 @@ import java.util.Collections; 
import java.util.Objects;

import java.util.Set;



// TODO: Add documents

/** @hide */

/**

 * This class represents a configuration for a network template class of underlying cellular

 * networks.

 *

 * <p>See {@link VcnUnderlyingNetworkTemplate}

 *

 * @hide

 */

public final class VcnCellUnderlyingNetworkTemplate extends VcnUnderlyingNetworkTemplate {

    private static final String ALLOWED_NETWORK_PLMN_IDS_KEY = "mAllowedNetworkPlmnIds";

    @NonNull private final Set<String> mAllowedNetworkPlmnIds;

    private static final String ALLOWED_SPECIFIC_CARRIER_IDS_KEY = "mAllowedSpecificCarrierIds";

    @NonNull private final Set<Integer> mAllowedSpecificCarrierIds;



    private static final String ALLOW_ROAMING_KEY = "mAllowRoaming";

    private final boolean mAllowRoaming;

    private static final String ROAMING_MATCH_KEY = "mRoamingMatchCriteria";

    private final int mRoamingMatchCriteria;



    private static final String REQUIRE_OPPORTUNISTIC_KEY = "mRequireOpportunistic";

    private final boolean mRequireOpportunistic;

    private static final String OPPORTUNISTIC_MATCH_KEY = "mOpportunisticMatchCriteria";

    private final int mOpportunisticMatchCriteria;



    private VcnCellUnderlyingNetworkTemplate(

            int networkQuality,

            boolean allowMetered,

            int meteredMatchCriteria,

            Set<String> allowedNetworkPlmnIds,

            Set<Integer> allowedSpecificCarrierIds,

            boolean allowRoaming,

            boolean requireOpportunistic) {

        super(NETWORK_PRIORITY_TYPE_CELL, networkQuality, allowMetered);

            int roamingMatchCriteria,

            int opportunisticMatchCriteria) {

        super(NETWORK_PRIORITY_TYPE_CELL, networkQuality, meteredMatchCriteria);

        mAllowedNetworkPlmnIds = new ArraySet<>(allowedNetworkPlmnIds);

        mAllowedSpecificCarrierIds = new ArraySet<>(allowedSpecificCarrierIds);

        mAllowRoaming = allowRoaming;

        mRequireOpportunistic = requireOpportunistic;

        mRoamingMatchCriteria = roamingMatchCriteria;

        mOpportunisticMatchCriteria = opportunisticMatchCriteria;



        validate();

    }
@@ -72,15 +85,17 @@ public final class VcnCellUnderlyingNetworkTemplate extends VcnUnderlyingNetwork 
    protected void validate() {

        super.validate();

        validatePlmnIds(mAllowedNetworkPlmnIds);

        Objects.requireNonNull(mAllowedSpecificCarrierIds, "allowedCarrierIds is null");

        Objects.requireNonNull(mAllowedSpecificCarrierIds, "matchingCarrierIds is null");

        validateMatchCriteria(mRoamingMatchCriteria, "mRoamingMatchCriteria");

        validateMatchCriteria(mOpportunisticMatchCriteria, "mOpportunisticMatchCriteria");

    }



    private static void validatePlmnIds(Set<String> allowedNetworkPlmnIds) {

        Objects.requireNonNull(allowedNetworkPlmnIds, "allowedNetworkPlmnIds is null");

    private static void validatePlmnIds(Set<String> matchingOperatorPlmnIds) {

        Objects.requireNonNull(matchingOperatorPlmnIds, "matchingOperatorPlmnIds is null");



        // A valid PLMN is a concatenation of MNC and MCC, and thus consists of 5 or 6 decimal

        // digits.

        for (String id : allowedNetworkPlmnIds) {

        for (String id : matchingOperatorPlmnIds) {

            if ((id.length() == 5 || id.length() == 6) && id.matches("[0-9]+")) {

                continue;

            } else {
@@ -97,7 +112,7 @@ public final class VcnCellUnderlyingNetworkTemplate extends VcnUnderlyingNetwork 
        Objects.requireNonNull(in, "PersistableBundle is null");



        final int networkQuality = in.getInt(NETWORK_QUALITY_KEY);

        final boolean allowMetered = in.getBoolean(ALLOW_METERED_KEY);

        final int meteredMatchCriteria = in.getInt(METERED_MATCH_KEY);



        final PersistableBundle plmnIdsBundle =

                in.getPersistableBundle(ALLOWED_NETWORK_PLMN_IDS_KEY);
@@ -114,16 +129,16 @@ public final class VcnCellUnderlyingNetworkTemplate extends VcnUnderlyingNetwork 
                        PersistableBundleUtils.toList(

                                specificCarrierIdsBundle, INTEGER_DESERIALIZER));



        final boolean allowRoaming = in.getBoolean(ALLOW_ROAMING_KEY);

        final boolean requireOpportunistic = in.getBoolean(REQUIRE_OPPORTUNISTIC_KEY);

        final int roamingMatchCriteria = in.getInt(ROAMING_MATCH_KEY);

        final int opportunisticMatchCriteria = in.getInt(OPPORTUNISTIC_MATCH_KEY);



        return new VcnCellUnderlyingNetworkTemplate(

                networkQuality,

                allowMetered,

                meteredMatchCriteria,

                allowedNetworkPlmnIds,

                allowedSpecificCarrierIds,

                allowRoaming,

                requireOpportunistic);

                roamingMatchCriteria,

                opportunisticMatchCriteria);

    }



    /** @hide */
@@ -143,35 +158,51 @@ public final class VcnCellUnderlyingNetworkTemplate extends VcnUnderlyingNetwork 
                        new ArrayList<>(mAllowedSpecificCarrierIds), INTEGER_SERIALIZER);

        result.putPersistableBundle(ALLOWED_SPECIFIC_CARRIER_IDS_KEY, specificCarrierIdsBundle);



        result.putBoolean(ALLOW_ROAMING_KEY, mAllowRoaming);

        result.putBoolean(REQUIRE_OPPORTUNISTIC_KEY, mRequireOpportunistic);

        result.putInt(ROAMING_MATCH_KEY, mRoamingMatchCriteria);

        result.putInt(OPPORTUNISTIC_MATCH_KEY, mOpportunisticMatchCriteria);



        return result;

    }



    /** Retrieve the allowed PLMN IDs, or an empty set if any PLMN ID is acceptable. */

    /**

     * Retrieve the matching operator PLMN IDs, or an empty set if any PLMN ID is acceptable.

     *

     * @see Builder#setOperatorPlmnIds(Set)

     */

    @NonNull

    public Set<String> getAllowedOperatorPlmnIds() {

    public Set<String> getOperatorPlmnIds() {

        return Collections.unmodifiableSet(mAllowedNetworkPlmnIds);

    }



    /**

     * Retrieve the allowed specific carrier IDs, or an empty set if any specific carrier ID is

     * acceptable.

     * Retrieve the matching sim specific carrier IDs, or an empty set if any sim specific carrier

     * ID is acceptable.

     *

     * @see Builder#setSimSpecificCarrierIds(Set)

     */

    @NonNull

    public Set<Integer> getAllowedSpecificCarrierIds() {

    public Set<Integer> getSimSpecificCarrierIds() {

        return Collections.unmodifiableSet(mAllowedSpecificCarrierIds);

    }



    /** Return if roaming is allowed. */

    public boolean allowRoaming() {

        return mAllowRoaming;

    /**

     * Return the matching criteria for roaming networks.

     *

     * @see Builder#setRoaming(int)

     */

    @MatchCriteria

    public int getRoaming() {

        return mRoamingMatchCriteria;

    }



    /** Return if requiring an opportunistic network. */

    public boolean requireOpportunistic() {

        return mRequireOpportunistic;

    /**

     * Return the matching criteria for opportunistic cellular subscriptions.

     *

     * @see Builder#setOpportunistic(int)

     */

    @MatchCriteria

    public int getOpportunistic() {

        return mOpportunisticMatchCriteria;

    }



    @Override
@@ -180,8 +211,8 @@ public final class VcnCellUnderlyingNetworkTemplate extends VcnUnderlyingNetwork 
                super.hashCode(),

                mAllowedNetworkPlmnIds,

                mAllowedSpecificCarrierIds,

                mAllowRoaming,

                mRequireOpportunistic);

                mRoamingMatchCriteria,

                mOpportunisticMatchCriteria);

    }



    @Override
@@ -197,8 +228,8 @@ public final class VcnCellUnderlyingNetworkTemplate extends VcnUnderlyingNetwork 
        final VcnCellUnderlyingNetworkTemplate rhs = (VcnCellUnderlyingNetworkTemplate) other;

        return Objects.equals(mAllowedNetworkPlmnIds, rhs.mAllowedNetworkPlmnIds)

                && Objects.equals(mAllowedSpecificCarrierIds, rhs.mAllowedSpecificCarrierIds)

                && mAllowRoaming == rhs.mAllowRoaming

                && mRequireOpportunistic == rhs.mRequireOpportunistic;

                && mRoamingMatchCriteria == rhs.mRoamingMatchCriteria

                && mOpportunisticMatchCriteria == rhs.mOpportunisticMatchCriteria;

    }



    /** @hide */
@@ -206,77 +237,125 @@ public final class VcnCellUnderlyingNetworkTemplate extends VcnUnderlyingNetwork 
    void dumpTransportSpecificFields(IndentingPrintWriter pw) {

        pw.println("mAllowedNetworkPlmnIds: " + mAllowedNetworkPlmnIds.toString());

        pw.println("mAllowedSpecificCarrierIds: " + mAllowedSpecificCarrierIds.toString());

        pw.println("mAllowRoaming: " + mAllowRoaming);

        pw.println("mRequireOpportunistic: " + mRequireOpportunistic);

        pw.println("mRoamingMatchCriteria: " + getMatchCriteriaString(mRoamingMatchCriteria));

        pw.println(

                "mOpportunisticMatchCriteria: "

                        + getMatchCriteriaString(mOpportunisticMatchCriteria));

    }



    /** This class is used to incrementally build WifiNetworkPriority objects. */

    public static final class Builder extends VcnUnderlyingNetworkTemplate.Builder<Builder> {

    /** This class is used to incrementally build VcnCellUnderlyingNetworkTemplate objects. */

    public static final class Builder {

        private int mNetworkQuality = NETWORK_QUALITY_ANY;

        private int mMeteredMatchCriteria = MATCH_ANY;



        @NonNull private final Set<String> mAllowedNetworkPlmnIds = new ArraySet<>();

        @NonNull private final Set<Integer> mAllowedSpecificCarrierIds = new ArraySet<>();



        private boolean mAllowRoaming = false;

        private boolean mRequireOpportunistic = false;

        private int mRoamingMatchCriteria = MATCH_ANY;

        private int mOpportunisticMatchCriteria = MATCH_ANY;



        /** Construct a Builder object. */

        public Builder() {}



        /**

         * Set allowed operator PLMN IDs.

         * Set the required network quality to match this template.

         *

         * <p>Network quality is a aggregation of multiple signals that reflect the network link

         * metrics. For example, the network validation bit (see {@link

         * NetworkCapabilities#NET_CAPABILITY_VALIDATED}), estimated first hop transport bandwidth

         * and signal strength.

         *

         * @param networkQuality the required network quality. Defaults to NETWORK_QUALITY_ANY

         * @hide

         */

        @NonNull

        public Builder setNetworkQuality(@NetworkQuality int networkQuality) {

            validateNetworkQuality(networkQuality);



            mNetworkQuality = networkQuality;

            return this;

        }



        /**

         * Set the matching criteria for metered networks.

         *

         * @param matchCriteria the matching criteria for metered networks. Defaults to {@link

         *     #MATCH_ANY}. See {@link NetworkCapabilities#NET_CAPABILITY_NOT_METERED}

         */

        // The matching getter is defined in the super class. Please see {@link

        // VcnUnderlyingNetworkTemplate#getMetered()}

        @SuppressLint("MissingGetterMatchingBuilder")

        @NonNull

        public Builder setMetered(@MatchCriteria int matchCriteria) {

            validateMatchCriteria(matchCriteria, "setMetered");



            mMeteredMatchCriteria = matchCriteria;

            return this;

        }



        /**

         * Set operator PLMN IDs with which a network can match this template.

         *

         * <p>This is used to distinguish cases where roaming agreements may dictate a different

         * priority from a partner's networks.

         *

         * @param allowedNetworkPlmnIds the allowed operator PLMN IDs in String. Defaults to an

         *     empty set, allowing ANY PLMN ID. A valid PLMN is a concatenation of MNC and MCC, and

         *     thus consists of 5 or 6 decimal digits. See {@link SubscriptionInfo#getMccString()}

         *     and {@link SubscriptionInfo#getMncString()}.

         * @param operatorPlmnIds the matching operator PLMN IDs in String. Network with one of the

         *     matching PLMN IDs can match this template. Defaults to an empty set, allowing ANY

         *     PLMN ID. A valid PLMN is a concatenation of MNC and MCC, and thus consists of 5 or 6

         *     decimal digits. See {@link SubscriptionInfo#getMccString()} and {@link

         *     SubscriptionInfo#getMncString()}.

         */

        @NonNull

        public Builder setAllowedOperatorPlmnIds(@NonNull Set<String> allowedNetworkPlmnIds) {

            validatePlmnIds(allowedNetworkPlmnIds);

        public Builder setOperatorPlmnIds(@NonNull Set<String> operatorPlmnIds) {

            validatePlmnIds(operatorPlmnIds);



            mAllowedNetworkPlmnIds.clear();

            mAllowedNetworkPlmnIds.addAll(allowedNetworkPlmnIds);

            mAllowedNetworkPlmnIds.addAll(operatorPlmnIds);

            return this;

        }



        /**

         * Set allowed specific carrier IDs.

         * Set sim specific carrier IDs with which a network can match this template.

         *

         * @param allowedSpecificCarrierIds the allowed specific carrier IDs. Defaults to an empty

         *     set, allowing ANY carrier ID. See {@link TelephonyManager#getSimSpecificCarrierId()}.

         * @param simSpecificCarrierIds the matching sim specific carrier IDs. Network with one of

         *     the sim specific carrier IDs can match this template. Defaults to an empty set,

         *     allowing ANY carrier ID. See {@link TelephonyManager#getSimSpecificCarrierId()}.

         */

        @NonNull

        public Builder setAllowedSpecificCarrierIds(

                @NonNull Set<Integer> allowedSpecificCarrierIds) {

            Objects.requireNonNull(allowedSpecificCarrierIds, "allowedCarrierIds is null");

        public Builder setSimSpecificCarrierIds(@NonNull Set<Integer> simSpecificCarrierIds) {

            Objects.requireNonNull(simSpecificCarrierIds, "simSpecificCarrierIds is null");



            mAllowedSpecificCarrierIds.clear();

            mAllowedSpecificCarrierIds.addAll(allowedSpecificCarrierIds);

            mAllowedSpecificCarrierIds.addAll(simSpecificCarrierIds);

            return this;

        }



        /**

         * Set if roaming is allowed.

         * Set the matching criteria for roaming networks.

         *

         * @param allowRoaming the flag to indicate if roaming is allowed. Defaults to {@code

         *     false}.

         * @param matchCriteria the matching criteria for roaming networks. Defaults to {@link

         *     #MATCH_ANY}. See {@link NetworkCapabilities#NET_CAPABILITY_NOT_ROAMING}.

         */

        @NonNull

        public Builder setAllowRoaming(boolean allowRoaming) {

            mAllowRoaming = allowRoaming;

        public Builder setRoaming(@MatchCriteria int matchCriteria) {

            validateMatchCriteria(matchCriteria, "setRoaming");



            mRoamingMatchCriteria = matchCriteria;

            return this;

        }



        /**

         * Set if requiring an opportunistic network.

         * Set the matching criteria for opportunistic cellular subscriptions.

         *

         * @param requireOpportunistic the flag to indicate if caller requires an opportunistic

         *     network. Defaults to {@code false}.

         * @param matchCriteria the matching criteria for opportunistic cellular subscriptions.

         *     Defaults to {@link #MATCH_ANY}. See {@link

         *     SubscriptionManager#setOpportunistic(boolean, int)}

         */

        @NonNull

        public Builder setRequireOpportunistic(boolean requireOpportunistic) {

            mRequireOpportunistic = requireOpportunistic;

        public Builder setOpportunistic(@MatchCriteria int matchCriteria) {

            validateMatchCriteria(matchCriteria, "setOpportunistic");



            mOpportunisticMatchCriteria = matchCriteria;

            return this;

        }
@@ -285,17 +364,11 @@ public final class VcnCellUnderlyingNetworkTemplate extends VcnUnderlyingNetwork 
        public VcnCellUnderlyingNetworkTemplate build() {

            return new VcnCellUnderlyingNetworkTemplate(

                    mNetworkQuality,

                    mAllowMetered,

                    mMeteredMatchCriteria,

                    mAllowedNetworkPlmnIds,

                    mAllowedSpecificCarrierIds,

                    mAllowRoaming,

                    mRequireOpportunistic);

        }



        /** @hide */

        @Override

        Builder self() {

            return this;

                    mRoamingMatchCriteria,

                    mOpportunisticMatchCriteria);

        }

    }

}

core/java/android/net/vcn/VcnGatewayConnectionConfig.java

+75 −60

File changed.

Preview size limit exceeded, changes collapsed.

core/java/android/net/vcn/VcnUnderlyingNetworkTemplate.java

+99 −63
Original line number Diff line number Diff line
@@ -15,11 +15,14 @@ 
 */

package android.net.vcn;



import static android.net.vcn.VcnUnderlyingNetworkTemplate.MATCH_ANY;



import static com.android.internal.annotations.VisibleForTesting.Visibility;



import android.annotation.IntDef;

import android.annotation.NonNull;

import android.annotation.Nullable;

import android.net.NetworkCapabilities;

import android.os.PersistableBundle;

import android.util.SparseArray;
@@ -31,17 +34,26 @@ import java.lang.annotation.Retention; 
import java.lang.annotation.RetentionPolicy;

import java.util.Objects;



// TODO: Add documents

/** @hide */

/**

 * This class represents a template containing set of underlying network requirements for doing

 * route selection.

 *

 * <p>Apps provisioning a VCN can configure the underlying network priority for each Gateway

 * Connection by setting a list (in priority order, most to least preferred) of the appropriate

 * subclasses in the VcnGatewayConnectionConfig. See {@link

 * VcnGatewayConnectionConfig.Builder#setVcnUnderlyingNetworkTemplates}

 *

 * @hide

 */

public abstract class VcnUnderlyingNetworkTemplate {

    /** @hide */

    protected static final int NETWORK_PRIORITY_TYPE_WIFI = 1;

    static final int NETWORK_PRIORITY_TYPE_WIFI = 1;

    /** @hide */

    protected static final int NETWORK_PRIORITY_TYPE_CELL = 2;

    static final int NETWORK_PRIORITY_TYPE_CELL = 2;



    /** Denotes that any network quality is acceptable */

    /** Denotes that any network quality is acceptable. @hide */

    public static final int NETWORK_QUALITY_ANY = 0;

    /** Denotes that network quality needs to be OK */

    /** Denotes that network quality needs to be OK. @hide */

    public static final int NETWORK_QUALITY_OK = 100000;



    private static final SparseArray<String> NETWORK_QUALITY_TO_STRING_MAP = new SparseArray<>();
@@ -56,34 +68,81 @@ public abstract class VcnUnderlyingNetworkTemplate { 
    @IntDef({NETWORK_QUALITY_OK, NETWORK_QUALITY_ANY})

    public @interface NetworkQuality {}



    /**

     * Used to configure the matching criteria of a network capability (See {@link

     * NetworkCapabilities}). Denotes that networks with or without the capability are both

     * acceptable to match the template.

     */

    public static final int MATCH_ANY = 0;



    /**

     * Used to configure the matching criteria of a network capability (See {@link

     * NetworkCapabilities}). Denotes that only network with the capability can match the template.

     */

    public static final int MATCH_REQUIRED = 1;



    /**

     * Used to configure the matching criteria of a network capability (See {@link

     * NetworkCapabilities}). Denotes that only network without the capability can match the

     * template.

     */

    public static final int MATCH_FORBIDDEN = 2;



    /** @hide */

    @Retention(RetentionPolicy.SOURCE)

    @IntDef({MATCH_ANY, MATCH_REQUIRED, MATCH_FORBIDDEN})

    public @interface MatchCriteria {}



    private static final SparseArray<String> MATCH_CRITERIA_TO_STRING_MAP = new SparseArray<>();



    static {

        MATCH_CRITERIA_TO_STRING_MAP.put(MATCH_ANY, "MATCH_ANY");

        MATCH_CRITERIA_TO_STRING_MAP.put(MATCH_REQUIRED, "MATCH_REQUIRED");

        MATCH_CRITERIA_TO_STRING_MAP.put(MATCH_FORBIDDEN, "MATCH_FORBIDDEN");

    }



    private static final String NETWORK_PRIORITY_TYPE_KEY = "mNetworkPriorityType";

    private final int mNetworkPriorityType;



    /** @hide */

    protected static final String NETWORK_QUALITY_KEY = "mNetworkQuality";

    static final String NETWORK_QUALITY_KEY = "mNetworkQuality";



    private final int mNetworkQuality;



    /** @hide */

    protected static final String ALLOW_METERED_KEY = "mAllowMetered";

    private final boolean mAllowMetered;

    static final String METERED_MATCH_KEY = "mMeteredMatchCriteria";



    private final int mMeteredMatchCriteria;



    /** @hide */

    protected VcnUnderlyingNetworkTemplate(

            int networkPriorityType, int networkQuality, boolean allowMetered) {

    VcnUnderlyingNetworkTemplate(

            int networkPriorityType, int networkQuality, int meteredMatchCriteria) {

        mNetworkPriorityType = networkPriorityType;

        mNetworkQuality = networkQuality;

        mAllowMetered = allowMetered;

        mMeteredMatchCriteria = meteredMatchCriteria;

    }



    private static void validateNetworkQuality(int networkQuality) {

    /** @hide */

    static void validateNetworkQuality(int networkQuality) {

        Preconditions.checkArgument(

                networkQuality == NETWORK_QUALITY_ANY || networkQuality == NETWORK_QUALITY_OK,

                "Invalid networkQuality:" + networkQuality);

    }



    /** @hide */

    static void validateMatchCriteria(int meteredMatchCriteria, String matchingCapability) {

        Preconditions.checkArgument(

                MATCH_CRITERIA_TO_STRING_MAP.contains(meteredMatchCriteria),

                "Invalid matching criteria: "

                        + meteredMatchCriteria

                        + " for "

                        + matchingCapability);

    }



    /** @hide */

    protected void validate() {

        validateNetworkQuality(mNetworkQuality);

        validateMatchCriteria(mMeteredMatchCriteria, "mMeteredMatchCriteria");

    }



    /** @hide */
@@ -112,14 +171,14 @@ public abstract class VcnUnderlyingNetworkTemplate { 


        result.putInt(NETWORK_PRIORITY_TYPE_KEY, mNetworkPriorityType);

        result.putInt(NETWORK_QUALITY_KEY, mNetworkQuality);

        result.putBoolean(ALLOW_METERED_KEY, mAllowMetered);

        result.putInt(METERED_MATCH_KEY, mMeteredMatchCriteria);



        return result;

    }



    @Override

    public int hashCode() {

        return Objects.hash(mNetworkPriorityType, mNetworkQuality, mAllowMetered);

        return Objects.hash(mNetworkPriorityType, mNetworkQuality, mMeteredMatchCriteria);

    }



    @Override
@@ -131,7 +190,17 @@ public abstract class VcnUnderlyingNetworkTemplate { 
        final VcnUnderlyingNetworkTemplate rhs = (VcnUnderlyingNetworkTemplate) other;

        return mNetworkPriorityType == rhs.mNetworkPriorityType

                && mNetworkQuality == rhs.mNetworkQuality

                && mAllowMetered == rhs.mAllowMetered;

                && mMeteredMatchCriteria == rhs.mMeteredMatchCriteria;

    }



    /** @hide */

    static String getNameString(SparseArray<String> toStringMap, int key) {

        return toStringMap.get(key, "Invalid value " + key);

    }



    /** @hide */

    static String getMatchCriteriaString(int meteredMatchCriteria) {

        return getNameString(MATCH_CRITERIA_TO_STRING_MAP, meteredMatchCriteria);

    }



    /** @hide */
@@ -148,65 +217,32 @@ public abstract class VcnUnderlyingNetworkTemplate { 


        pw.println(

                "mNetworkQuality: "

                        + NETWORK_QUALITY_TO_STRING_MAP.get(

                                mNetworkQuality, "Invalid value " + mNetworkQuality));

        pw.println("mAllowMetered: " + mAllowMetered);

                        + getNameString(NETWORK_QUALITY_TO_STRING_MAP, mNetworkQuality));

        pw.println("mMeteredMatchCriteria: " + getMatchCriteriaString(mMeteredMatchCriteria));

        dumpTransportSpecificFields(pw);



        pw.decreaseIndent();

    }



    /** Retrieve the required network quality. */

    @NetworkQuality

    public int getNetworkQuality() {

        return mNetworkQuality;

    }



    /** Return if a metered network is allowed. */

    public boolean allowMetered() {

        return mAllowMetered;

    }



    /**

     * This class is used to incrementally build VcnUnderlyingNetworkTemplate objects.

     * Retrieve the required network quality to match this template.

     *

     * @param <T> The subclass to be built.

     */

    public abstract static class Builder<T extends Builder<T>> {

        /** @hide */

        protected int mNetworkQuality = NETWORK_QUALITY_ANY;

        /** @hide */

        protected boolean mAllowMetered = false;



        /** @hide */

        protected Builder() {}



        /**

         * Set the required network quality.

         *

         * @param networkQuality the required network quality. Defaults to NETWORK_QUALITY_ANY

     * @see Builder#setNetworkQuality(int)

     * @hide

     */

        @NonNull

        public T setNetworkQuality(@NetworkQuality int networkQuality) {

            validateNetworkQuality(networkQuality);



            mNetworkQuality = networkQuality;

            return self();

    @NetworkQuality

    public int getNetworkQuality() {

        return mNetworkQuality;

    }



    /**

         * Set if a metered network is allowed.

     * Return the matching criteria for metered networks.

     *

         * @param allowMetered the flag to indicate if a metered network is allowed, defaults to

         *     {@code false}

     * @see VcnWifiUnderlyingNetworkTemplate.Builder#setMetered(int)

     * @see VcnCellUnderlyingNetworkTemplate.Builder#setMetered(int)

     */

        @NonNull

        public T setAllowMetered(boolean allowMetered) {

            mAllowMetered = allowMetered;

            return self();

        }



        /** @hide */

        abstract T self();

    @MatchCriteria

    public int getMetered() {

        return mMeteredMatchCriteria;

    }

}

core/java/android/net/vcn/VcnWifiUnderlyingNetworkTemplate.java

+110 −30

File changed.

Preview size limit exceeded, changes collapsed.

services/core/java/com/android/server/vcn/routeselection/NetworkPriorityClassifier.java

+26 −12

File changed.

Preview size limit exceeded, changes collapsed.