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

Commit 52265aab authored by Cody Kesting's avatar Cody Kesting
Browse files

Update identification for onGatewayConnectionError(). 

This CL updates the identification method for
VcnStatusCallback#onGatewayConnectionErrror. Previously,
GatewayConnections were identified by an int[] specifying the
GatewayConnection's exposed NetworkCapabilities. Following API Council
feedback, this is updated to identify GatewayConnections by a
caller-provided String set in the VcnGatewayConnectionConfig.Builder.

Bug: 182345902
Bug: 180522464
Test: atest FrameworksVcnTests
Change-Id: I933c2330edb9bfc1b6bb62276debac02460e24f8
parent 01a61615

core/java/android/net/vcn/IVcnStatusCallback.aidl

+1 −1
Original line number Diff line number Diff line
@@ -20,7 +20,7 @@ package android.net.vcn; 
oneway interface IVcnStatusCallback {

    void onVcnStatusChanged(int statusCode);

    void onGatewayConnectionError(

            in int[] gatewayNetworkCapabilities,

            in String gatewayConnectionName,

            int errorCode,

            in String exceptionClass,

            in String exceptionMessage);

core/java/android/net/vcn/VcnConfig.java

+13 −0
Original line number Diff line number Diff line
@@ -183,12 +183,25 @@ public final class VcnConfig implements Parcelable { 
         *

         * @param gatewayConnectionConfig the configuration for an individual gateway connection

         * @return this {@link Builder} instance, for chaining

         * @throws IllegalArgumentException if a VcnGatewayConnectionConfig has already been set for

         *     this {@link VcnConfig} with the same GatewayConnection name (as returned via {@link

         *     VcnGatewayConnectionConfig#getGatewayConnectionName()}).

         */

        @NonNull

        public Builder addGatewayConnectionConfig(

                @NonNull VcnGatewayConnectionConfig gatewayConnectionConfig) {

            Objects.requireNonNull(gatewayConnectionConfig, "gatewayConnectionConfig was null");



            for (final VcnGatewayConnectionConfig vcnGatewayConnectionConfig :

                    mGatewayConnectionConfigs) {

                if (vcnGatewayConnectionConfig

                        .getGatewayConnectionName()

                        .equals(gatewayConnectionConfig.getGatewayConnectionName())) {

                    throw new IllegalArgumentException(

                            "GatewayConnection for specified name already exists");

                }

            }



            mGatewayConnectionConfigs.add(gatewayConnectionConfig);

            return this;

        }

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

+48 −1
Original line number Diff line number Diff line
@@ -148,6 +148,8 @@ public final class VcnGatewayConnectionConfig { 
                TimeUnit.MINUTES.toMillis(5),

                TimeUnit.MINUTES.toMillis(15)

            };

    private static final String GATEWAY_CONNECTION_NAME_KEY = "mGatewayConnectionName";

    @NonNull private final String mGatewayConnectionName;



    private static final String CTRL_PLANE_CONFIG_KEY = "mCtrlPlaneConfig";

    @NonNull private VcnControlPlaneConfig mCtrlPlaneConfig;
@@ -166,11 +168,13 @@ public final class VcnGatewayConnectionConfig { 


    /** Builds a VcnGatewayConnectionConfig with the specified parameters. */

    private VcnGatewayConnectionConfig(

            @NonNull String gatewayConnectionName,

            @NonNull VcnControlPlaneConfig ctrlPlaneConfig,

            @NonNull Set<Integer> exposedCapabilities,

            @NonNull Set<Integer> underlyingCapabilities,

            @NonNull long[] retryIntervalsMs,

            @IntRange(from = MIN_MTU_V6) int maxMtu) {

        mGatewayConnectionName = gatewayConnectionName;

        mCtrlPlaneConfig = ctrlPlaneConfig;

        mExposedCapabilities = new TreeSet(exposedCapabilities);

        mUnderlyingCapabilities = new TreeSet(underlyingCapabilities);
@@ -192,6 +196,7 @@ public final class VcnGatewayConnectionConfig { 
        final PersistableBundle underlyingCapsBundle =

                in.getPersistableBundle(UNDERLYING_CAPABILITIES_KEY);



        mGatewayConnectionName = in.getString(GATEWAY_CONNECTION_NAME_KEY);

        mCtrlPlaneConfig = VcnControlPlaneConfig.fromPersistableBundle(ctrlPlaneConfigBundle);

        mExposedCapabilities = new TreeSet<>(PersistableBundleUtils.toList(

                exposedCapsBundle, PersistableBundleUtils.INTEGER_DESERIALIZER));
@@ -204,6 +209,7 @@ public final class VcnGatewayConnectionConfig { 
    }



    private void validate() {

        Objects.requireNonNull(mGatewayConnectionName, "gatewayConnectionName was null");

        Objects.requireNonNull(mCtrlPlaneConfig, "control plane config was null");



        Preconditions.checkArgument(
@@ -241,6 +247,21 @@ public final class VcnGatewayConnectionConfig { 
        }

    }



    /**

     * Returns the configured Gateway Connection name.

     *

     * <p>This name is used by the configuring apps to distinguish between

     * VcnGatewayConnectionConfigs configured on a single {@link VcnConfig}. This will be used as

     * the identifier in VcnStatusCallback invocations.

     *

     * @see VcnManager.VcnStatusCallback#onGatewayConnectionError

     * @hide

     */

    @NonNull

    public String getGatewayConnectionName() {

        return mGatewayConnectionName;

    }



    /**

     * Returns control plane configuration.

     *
@@ -364,6 +385,7 @@ public final class VcnGatewayConnectionConfig { 
                        new ArrayList<>(mUnderlyingCapabilities),

                        PersistableBundleUtils.INTEGER_SERIALIZER);



        result.putString(GATEWAY_CONNECTION_NAME_KEY, mGatewayConnectionName);

        result.putPersistableBundle(CTRL_PLANE_CONFIG_KEY, ctrlPlaneConfigBundle);

        result.putPersistableBundle(EXPOSED_CAPABILITIES_KEY, exposedCapsBundle);

        result.putPersistableBundle(UNDERLYING_CAPABILITIES_KEY, underlyingCapsBundle);
@@ -376,6 +398,7 @@ public final class VcnGatewayConnectionConfig { 
    @Override

    public int hashCode() {

        return Objects.hash(

                mGatewayConnectionName,

                mExposedCapabilities,

                mUnderlyingCapabilities,

                Arrays.hashCode(mRetryIntervalsMs),
@@ -389,7 +412,8 @@ public final class VcnGatewayConnectionConfig { 
        }



        final VcnGatewayConnectionConfig rhs = (VcnGatewayConnectionConfig) other;

        return mExposedCapabilities.equals(rhs.mExposedCapabilities)

        return mGatewayConnectionName.equals(rhs.mGatewayConnectionName)

                && mExposedCapabilities.equals(rhs.mExposedCapabilities)

                && mUnderlyingCapabilities.equals(rhs.mUnderlyingCapabilities)

                && Arrays.equals(mRetryIntervalsMs, rhs.mRetryIntervalsMs)

                && mMaxMtu == rhs.mMaxMtu;
@@ -399,6 +423,7 @@ public final class VcnGatewayConnectionConfig { 
     * This class is used to incrementally build {@link VcnGatewayConnectionConfig} objects.

     */

    public static final class Builder {

        @NonNull private final String mGatewayConnectionName;

        @NonNull private final VcnControlPlaneConfig mCtrlPlaneConfig;

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

        @NonNull private final Set<Integer> mUnderlyingCapabilities = new ArraySet();
@@ -416,8 +441,29 @@ public final class VcnGatewayConnectionConfig { 
         * @see VcnControlPlaneConfig

         */

        public Builder(@NonNull VcnControlPlaneConfig ctrlPlaneConfig) {

            this("" /* gatewayConnectionName */, ctrlPlaneConfig);

        }



        /**

         * Construct a Builder object.

         *

         * @param gatewayConnectionName the String GatewayConnection name for this

         *     VcnGatewayConnectionConfig. Each VcnGatewayConnectionConfig within a {@link

         *     VcnConfig} must be given a unique name. This name is used by the caller to

         *     distinguish between VcnGatewayConnectionConfigs configured on a single {@link

         *     VcnConfig}. This will be used as the identifier in VcnStatusCallback invocations.

         * @param ctrlPlaneConfig the control plane configuration

         * @see VcnControlPlaneConfig

         * @see VcnManager.VcnStatusCallback#onGatewayConnectionError

         * @hide

         */

        public Builder(

                @NonNull String gatewayConnectionName,

                @NonNull VcnControlPlaneConfig ctrlPlaneConfig) {

            Objects.requireNonNull(gatewayConnectionName, "gatewayConnectionName was null");

            Objects.requireNonNull(ctrlPlaneConfig, "ctrlPlaneConfig was null");



            mGatewayConnectionName = gatewayConnectionName;

            mCtrlPlaneConfig = ctrlPlaneConfig;

        }
@@ -562,6 +608,7 @@ public final class VcnGatewayConnectionConfig { 
        @NonNull

        public VcnGatewayConnectionConfig build() {

            return new VcnGatewayConnectionConfig(

                    mGatewayConnectionName,

                    mCtrlPlaneConfig,

                    mExposedCapabilities,

                    mUnderlyingCapabilities,

core/java/android/net/vcn/VcnManager.java

+2 −2
Original line number Diff line number Diff line
@@ -586,7 +586,7 @@ public class VcnManager { 
        // TODO(b/180521637): use ServiceSpecificException for safer Exception 'parceling'

        @Override

        public void onGatewayConnectionError(

                @NonNull int[] networkCapabilities,

                @NonNull String gatewayConnectionName,

                @VcnErrorCode int errorCode,

                @Nullable String exceptionClass,

                @Nullable String exceptionMessage) {
@@ -597,7 +597,7 @@ public class VcnManager { 
                            mExecutor.execute(

                                    () ->

                                            mCallback.onGatewayConnectionError(

                                                    networkCapabilities, errorCode, cause)));

                                                    new int[0], errorCode, cause)));

        }



        private static Throwable createThrowableByClassName(

services/core/java/com/android/server/VcnManagementService.java

+3 −3
Original line number Diff line number Diff line
@@ -926,7 +926,7 @@ public class VcnManagementService extends IVcnManagementService.Stub { 


        /** Called by a Vcn to signal that an error occurred. */

        void onGatewayConnectionError(

                @NonNull int[] networkCapabilities,

                @NonNull String gatewayConnectionName,

                @VcnErrorCode int errorCode,

                @Nullable String exceptionClass,

                @Nullable String exceptionMessage);
@@ -955,7 +955,7 @@ public class VcnManagementService extends IVcnManagementService.Stub { 


        @Override

        public void onGatewayConnectionError(

                @NonNull int[] networkCapabilities,

                @NonNull String gatewayConnectionName,

                @VcnErrorCode int errorCode,

                @Nullable String exceptionClass,

                @Nullable String exceptionMessage) {
@@ -971,7 +971,7 @@ public class VcnManagementService extends IVcnManagementService.Stub { 
                        Binder.withCleanCallingIdentity(

                                () ->

                                        cbInfo.mCallback.onGatewayConnectionError(

                                                networkCapabilities,

                                                gatewayConnectionName,

                                                errorCode,

                                                exceptionClass,

                                                exceptionMessage));