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

Commit 90f27fc8 authored by Cody Kesting's avatar Cody Kesting
Browse files

Define VcnUnderlyingNetworkPolicy.

Bug: 175729529
Test: atest FrameworksVcnTests
Change-Id: I57c732640d6d21db1f4d68c69ff320918e7891c3
parent 9472f9c0
Loading
Loading
Loading
Loading
+20 −0
Original line number Diff line number Diff line
/*
 * Copyright (C) 2020 The Android Open Source Project
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package android.net.vcn;

/** @hide */
parcelable VcnUnderlyingNetworkPolicy;
+110 −0
Original line number Diff line number Diff line
/*
 * Copyright (C) 2020 The Android Open Source Project
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package android.net.vcn;

import android.annotation.NonNull;
import android.net.NetworkCapabilities;
import android.os.Parcel;
import android.os.Parcelable;

import java.util.Objects;

/**
 * VcnUnderlyingNetworkPolicy represents the Network policy for a VCN-managed Network.
 *
 * <p>Transports that are bringing up networks capable of acting as a VCN's underlying network
 * should query for policy state upon major capability changes (e.g. changing of TRUSTED bit), and
 * when prompted by VcnManagementService via VcnUnderlyingNetworkPolicyListener.
 *
 * @hide
 */
public final class VcnUnderlyingNetworkPolicy implements Parcelable {
    private final boolean mIsTearDownRequested;
    private final NetworkCapabilities mMergedNetworkCapabilities;

    /**
     * Constructs a VcnUnderlyingNetworkPolicy with the specified parameters.
     *
     * @hide
     */
    public VcnUnderlyingNetworkPolicy(
            boolean isTearDownRequested, @NonNull NetworkCapabilities mergedNetworkCapabilities) {
        Objects.requireNonNull(
                mergedNetworkCapabilities, "mergedNetworkCapabilities must be nonnull");

        mIsTearDownRequested = isTearDownRequested;
        mMergedNetworkCapabilities = mergedNetworkCapabilities;
    }

    /**
     * Returns whether this Carrier VCN policy policy indicates that the underlying Network should
     * be torn down.
     */
    public boolean isTeardownRequested() {
        return mIsTearDownRequested;
    }

    /**
     * Returns the NetworkCapabilities with Carrier VCN policy bits merged into the provided
     * capabilities.
     */
    @NonNull
    public NetworkCapabilities getMergedNetworkCapabilities() {
        return mMergedNetworkCapabilities;
    }

    @Override
    public int hashCode() {
        return Objects.hash(mIsTearDownRequested, mMergedNetworkCapabilities);
    }

    @Override
    public boolean equals(Object o) {
        if (this == o) return true;
        if (!(o instanceof VcnUnderlyingNetworkPolicy)) return false;
        final VcnUnderlyingNetworkPolicy that = (VcnUnderlyingNetworkPolicy) o;

        return mIsTearDownRequested == that.mIsTearDownRequested
                && mMergedNetworkCapabilities.equals(that.mMergedNetworkCapabilities);
    }

    /** {@inheritDoc} */
    @Override
    public int describeContents() {
        return 0;
    }

    /** {@inheritDoc} */
    @Override
    public void writeToParcel(@NonNull Parcel dest, int flags) {
        dest.writeBoolean(mIsTearDownRequested);
        dest.writeParcelable(mMergedNetworkCapabilities, flags);
    }

    /** Implement the Parcelable interface */
    public static final @NonNull Creator<VcnUnderlyingNetworkPolicy> CREATOR =
            new Creator<VcnUnderlyingNetworkPolicy>() {
                public VcnUnderlyingNetworkPolicy createFromParcel(Parcel in) {
                    return new VcnUnderlyingNetworkPolicy(
                            in.readBoolean(), in.readParcelable(null));
                }

                public VcnUnderlyingNetworkPolicy[] newArray(int size) {
                    return new VcnUnderlyingNetworkPolicy[size];
                }
            };
}
+1 −0
Original line number Diff line number Diff line
@@ -16,6 +16,7 @@ android_test {
        "frameworks-base-testutils",
        "framework-protos",
        "mockito-target-minus-junit4",
        "net-tests-utils",
        "platform-test-annotations",
        "services.core",
    ],
+51 −0
Original line number Diff line number Diff line
/*
 * Copyright (C) 2020 The Android Open Source Project
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package android.net.vcn;

import static com.android.testutils.ParcelUtils.assertParcelSane;

import static org.junit.Assert.assertEquals;
import static org.junit.Assert.assertNotEquals;

import android.net.NetworkCapabilities;

import org.junit.Test;

public class VcnUnderlyingNetworkPolicyTest {
    private static final VcnUnderlyingNetworkPolicy DEFAULT_NETWORK_POLICY =
            new VcnUnderlyingNetworkPolicy(
                    false /* isTearDownRequested */, new NetworkCapabilities());
    private static final VcnUnderlyingNetworkPolicy SAMPLE_NETWORK_POLICY =
            new VcnUnderlyingNetworkPolicy(
                    true /* isTearDownRequested */,
                    new NetworkCapabilities.Builder()
                            .addTransportType(NetworkCapabilities.TRANSPORT_CELLULAR)
                            .build());

    @Test
    public void testEquals() {
        assertEquals(DEFAULT_NETWORK_POLICY, DEFAULT_NETWORK_POLICY);
        assertEquals(SAMPLE_NETWORK_POLICY, SAMPLE_NETWORK_POLICY);

        assertNotEquals(DEFAULT_NETWORK_POLICY, SAMPLE_NETWORK_POLICY);
    }

    @Test
    public void testParcelUnparcel() {
        assertParcelSane(SAMPLE_NETWORK_POLICY, 2);
    }
}