LineageOS/android_packages_modules_Connectivity
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Adding API stubs for application network routing

Browse Source 
Bug: 171795464
Test: atest FrameworksNetTests
Change-Id: Ib055aa37a7bf0c48c335307afc2258aa869c4267
This commit is contained in:
James Mattis
2020-10-28 21:48:54 -07:00
parent 60b84b216b
commit 356a879404
3 changed files with 298 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

5
core/java/android/net/ConnectivityManager.java
View File

@@ -4816,4 +4816,9 @@ public class ConnectivityManager {
e.rethrowFromSystemServer();
}
}
private void setOemNetworkPreference(@NonNull OemNetworkPreferences preference) {
Log.d(TAG, "setOemNetworkPreference called with preference: "
+ preference.toString());
}
}

189
core/java/android/net/OemNetworkPreferences.java Normal file
View File

@@ -0,0 +1,189 @@
/*
* 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;
import android.annotation.IntDef;
import android.annotation.NonNull;
import android.os.Parcelable;
import android.util.SparseArray;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.util.ArrayList;
import java.util.Collections;
import java.util.List;
import java.util.Objects;
/** @hide */
public final class OemNetworkPreferences implements Parcelable {
/**
* Use default behavior requesting networks. Equivalent to not setting any preference at all.
*/
public static final int OEM_NETWORK_PREFERENCE_DEFAULT = 0;
/**
* Prefer networks in order: NET_CAPABILITY_NOT_METERED, NET_CAPABILITY_OEM_PAID, default.
*/
public static final int OEM_NETWORK_PREFERENCE_OEM_PAID = 1;
/**
* Prefer networks in order: NET_CAPABILITY_NOT_METERED, NET_CAPABILITY_OEM_PAID.
*/
public static final int OEM_NETWORK_PREFERENCE_OEM_PAID_NO_FALLBACK = 2;
/**
* Prefer only NET_CAPABILITY_OEM_PAID networks.
*/
public static final int OEM_NETWORK_PREFERENCE_OEM_PAID_ONLY = 3;
/**
* Prefer only NET_CAPABILITY_OEM_PRIVATE networks.
*/
public static final int OEM_NETWORK_PREFERENCE_OEM_PRIVATE_ONLY = 4;
@NonNull
private final SparseArray<List<String>> mNetworkMappings;
@NonNull
public SparseArray<List<String>> getNetworkPreferences() {
return mNetworkMappings.clone();
}
private OemNetworkPreferences(@NonNull SparseArray<List<String>> networkMappings) {
Objects.requireNonNull(networkMappings);
mNetworkMappings = networkMappings.clone();
}
@Override
public String toString() {
return "OemNetworkPreferences{" + "mNetworkMappings=" + mNetworkMappings + '}';
}
@Override
public boolean equals(Object o) {
if (this == o) return true;
if (o == null || getClass() != o.getClass()) return false;
OemNetworkPreferences that = (OemNetworkPreferences) o;
return mNetworkMappings.size() == that.mNetworkMappings.size()
&& mNetworkMappings.toString().equals(that.mNetworkMappings.toString());
}
@Override
public int hashCode() {
return Objects.hash(mNetworkMappings);
}
/**
* Builder used to create {@link OemNetworkPreferences} objects. Specify the preferred Network
* to package name mappings.
*
* @hide
*/
public static final class Builder {
private final SparseArray<List<String>> mNetworkMappings;
public Builder() {
mNetworkMappings = new SparseArray<>();
}
/**
* Add a network preference for a list of packages.
*
* @param preference the desired network preference to use
* @param packages full package names (e.g.: "com.google.apps.contacts") for apps to use
* the given preference
* @return The builder to facilitate chaining.
*/
@NonNull
public Builder addNetworkPreference(@OemNetworkPreference final int preference,
@NonNull List<String> packages) {
Objects.requireNonNull(packages);
mNetworkMappings.put(preference,
Collections.unmodifiableList(new ArrayList<>(packages)));
return this;
}
/**
* Build {@link OemNetworkPreferences} return the current OEM network preferences.
*/
@NonNull
public OemNetworkPreferences build() {
return new OemNetworkPreferences(mNetworkMappings);
}
}
/** @hide */
@IntDef(prefix = "OEM_NETWORK_PREFERENCE_", value = {
OEM_NETWORK_PREFERENCE_DEFAULT,
OEM_NETWORK_PREFERENCE_OEM_PAID,
OEM_NETWORK_PREFERENCE_OEM_PAID_NO_FALLBACK,
OEM_NETWORK_PREFERENCE_OEM_PAID_ONLY,
OEM_NETWORK_PREFERENCE_OEM_PRIVATE_ONLY
})
@Retention(RetentionPolicy.SOURCE)
public @interface OemNetworkPreference {}
/**
* Return the string value for OemNetworkPreference
*
* @param value int value of OemNetworkPreference
* @return string version of OemNetworkPreference
*/
@NonNull
public static String oemNetworkPreferenceToString(@OemNetworkPreference int value) {
switch (value) {
case OEM_NETWORK_PREFERENCE_DEFAULT:
return "OEM_NETWORK_PREFERENCE_DEFAULT";
case OEM_NETWORK_PREFERENCE_OEM_PAID:
return "OEM_NETWORK_PREFERENCE_OEM_PAID";
case OEM_NETWORK_PREFERENCE_OEM_PAID_NO_FALLBACK:
return "OEM_NETWORK_PREFERENCE_OEM_PAID_NO_FALLBACK";
case OEM_NETWORK_PREFERENCE_OEM_PAID_ONLY:
return "OEM_NETWORK_PREFERENCE_OEM_PAID_ONLY";
case OEM_NETWORK_PREFERENCE_OEM_PRIVATE_ONLY:
return "OEM_NETWORK_PREFERENCE_OEM_PRIVATE_ONLY";
default:
return Integer.toHexString(value);
}
}
@Override
public void writeToParcel(@NonNull android.os.Parcel dest, int flags) {
dest.writeSparseArray(mNetworkMappings);
}
@Override
public int describeContents() {
return 0;
}
@NonNull
public static final Parcelable.Creator<OemNetworkPreferences> CREATOR =
new Parcelable.Creator<OemNetworkPreferences>() {
@Override
public OemNetworkPreferences[] newArray(int size) {
return new OemNetworkPreferences[size];
}
@Override
public OemNetworkPreferences createFromParcel(@NonNull android.os.Parcel in) {
return new OemNetworkPreferences(
in.readSparseArray(getClass().getClassLoader()));
}
};
}

104
tests/net/common/java/android/net/OemNetworkPreferencesTest.java Normal file
View File

@@ -0,0 +1,104 @@
/*
* 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;
import static com.android.testutils.MiscAsserts.assertThrows;
import static com.android.testutils.ParcelUtils.assertParcelSane;
import static org.junit.Assert.assertEquals;
import static org.junit.Assert.assertTrue;
import android.util.SparseArray;
import androidx.test.filters.SmallTest;
import androidx.test.runner.AndroidJUnit4;
import org.junit.Before;
import org.junit.Test;
import org.junit.runner.RunWith;
import java.util.ArrayList;
import java.util.List;
@RunWith(AndroidJUnit4.class)
@SmallTest
public class OemNetworkPreferencesTest {
private static final int TEST_PREF = OemNetworkPreferences.OEM_NETWORK_PREFERENCE_DEFAULT;
private static final String TEST_PACKAGE = "com.google.apps.contacts";
private final List<String> mPackages = new ArrayList<>();
private final OemNetworkPreferences.Builder mBuilder = new OemNetworkPreferences.Builder();
@Before
public void beforeEachTestMethod() {
mPackages.add(TEST_PACKAGE);
}
@Test
public void builderAddNetworkPreferenceRequiresNonNullPackages() {
assertThrows(NullPointerException.class,
() -> mBuilder.addNetworkPreference(TEST_PREF, null));
}
@Test
public void getNetworkPreferencesReturnsCorrectValue() {
final int expectedNumberOfMappings = 1;
mBuilder.addNetworkPreference(TEST_PREF, mPackages);
final SparseArray<List<String>> networkPreferences =
mBuilder.build().getNetworkPreferences();
assertEquals(expectedNumberOfMappings, networkPreferences.size());
assertEquals(mPackages.size(), networkPreferences.get(TEST_PREF).size());
assertEquals(mPackages.get(0), networkPreferences.get(TEST_PREF).get(0));
}
@Test
public void getNetworkPreferencesReturnsUnmodifiableValue() {
final String newPackage = "new.com.google.apps.contacts";
mBuilder.addNetworkPreference(TEST_PREF, mPackages);
final SparseArray<List<String>> networkPreferences =
mBuilder.build().getNetworkPreferences();
assertThrows(UnsupportedOperationException.class,
() -> networkPreferences.get(TEST_PREF).set(mPackages.size() - 1, newPackage));
assertThrows(UnsupportedOperationException.class,
() -> networkPreferences.get(TEST_PREF).add(newPackage));
}
@Test
public void toStringReturnsCorrectValue() {
mBuilder.addNetworkPreference(TEST_PREF, mPackages);
final String networkPreferencesString = mBuilder.build().getNetworkPreferences().toString();
assertTrue(networkPreferencesString.contains(Integer.toString(TEST_PREF)));
assertTrue(networkPreferencesString.contains(TEST_PACKAGE));
}
@Test
public void testOemNetworkPreferencesParcelable() {
mBuilder.addNetworkPreference(TEST_PREF, mPackages);
final OemNetworkPreferences prefs = mBuilder.build();
assertParcelSane(prefs, 1 /* fieldCount */);
}
}