| /* |
| * Copyright (C) 2021 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.annotation.SystemApi; |
| import android.os.Bundle; |
| import android.os.Parcelable; |
| |
| import java.lang.annotation.Retention; |
| import java.lang.annotation.RetentionPolicy; |
| import java.util.Collections; |
| import java.util.HashMap; |
| import java.util.Map; |
| import java.util.Objects; |
| |
| /** |
| * Network preferences to set the default active network on a per-application basis as per a given |
| * {@link OemNetworkPreference}. An example of this would be to set an application's network |
| * preference to {@link #OEM_NETWORK_PREFERENCE_OEM_PAID_NO_FALLBACK} which would have the default |
| * network for that application set to an unmetered network first if available and if not, it then |
| * set that application's default network to an OEM managed network if available. |
| * |
| * @hide |
| */ |
| @SystemApi |
| public final class OemNetworkPreferences implements Parcelable { |
| // Valid production preferences must be > 0, negative values reserved for testing |
| /** |
| * This preference is only to be used for testing and nothing else. |
| * Use only TRANSPORT_TEST transport networks. |
| * @hide |
| */ |
| public static final int OEM_NETWORK_PREFERENCE_TEST_ONLY = -2; |
| |
| /** |
| * This preference is only to be used for testing and nothing else. |
| * If an unmetered network is available, use it. |
| * Otherwise, if a network with the TRANSPORT_TEST transport is available, use it. |
| * Otherwise, use the general default network. |
| * @hide |
| */ |
| public static final int OEM_NETWORK_PREFERENCE_TEST = -1; |
| |
| /** |
| * Default in case this value is not set. Using it will result in an error. |
| */ |
| public static final int OEM_NETWORK_PREFERENCE_UNINITIALIZED = 0; |
| |
| /** |
| * If an unmetered network is available, use it. |
| * Otherwise, if a network with the OEM_PAID capability is available, use it. |
| * Otherwise, use the general default network. |
| */ |
| public static final int OEM_NETWORK_PREFERENCE_OEM_PAID = 1; |
| |
| /** |
| * If an unmetered network is available, use it. |
| * Otherwise, if a network with the OEM_PAID capability is available, use it. |
| * Otherwise, the app doesn't get a default network. |
| */ |
| public static final int OEM_NETWORK_PREFERENCE_OEM_PAID_NO_FALLBACK = 2; |
| |
| /** |
| * Use only NET_CAPABILITY_OEM_PAID networks. |
| */ |
| public static final int OEM_NETWORK_PREFERENCE_OEM_PAID_ONLY = 3; |
| |
| /** |
| * Use only NET_CAPABILITY_OEM_PRIVATE networks. |
| */ |
| public static final int OEM_NETWORK_PREFERENCE_OEM_PRIVATE_ONLY = 4; |
| |
| /** |
| * The max allowed value for an OEM network preference. |
| * @hide |
| */ |
| public static final int OEM_NETWORK_PREFERENCE_MAX = OEM_NETWORK_PREFERENCE_OEM_PRIVATE_ONLY; |
| |
| @NonNull |
| private final Bundle mNetworkMappings; |
| |
| /** |
| * Return whether this object is empty. |
| * @hide |
| */ |
| public boolean isEmpty() { |
| return mNetworkMappings.keySet().size() == 0; |
| } |
| |
| /** |
| * Return the currently built application package name to {@link OemNetworkPreference} mappings. |
| * @return the current network preferences map. |
| */ |
| @NonNull |
| public Map<String, Integer> getNetworkPreferences() { |
| return convertToUnmodifiableMap(mNetworkMappings); |
| } |
| |
| private OemNetworkPreferences(@NonNull final Bundle networkMappings) { |
| Objects.requireNonNull(networkMappings); |
| mNetworkMappings = (Bundle) networkMappings.clone(); |
| } |
| |
| @Override |
| public String toString() { |
| return "OemNetworkPreferences{" + "mNetworkMappings=" + getNetworkPreferences() + '}'; |
| } |
| |
| @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. |
| */ |
| public static final class Builder { |
| private final Bundle mNetworkMappings; |
| |
| public Builder() { |
| mNetworkMappings = new Bundle(); |
| } |
| |
| /** |
| * Constructor to populate the builder's values with an already built |
| * {@link OemNetworkPreferences}. |
| * @param preferences the {@link OemNetworkPreferences} to populate with. |
| */ |
| public Builder(@NonNull final OemNetworkPreferences preferences) { |
| Objects.requireNonNull(preferences); |
| mNetworkMappings = (Bundle) preferences.mNetworkMappings.clone(); |
| } |
| |
| /** |
| * Add a network preference for a given package. Previously stored values for the given |
| * package will be overwritten. |
| * |
| * @param packageName full package name (e.g.: "com.google.apps.contacts") of the app |
| * to use the given preference |
| * @param preference the desired network preference to use |
| * @return The builder to facilitate chaining. |
| */ |
| @NonNull |
| public Builder addNetworkPreference(@NonNull final String packageName, |
| @OemNetworkPreference final int preference) { |
| Objects.requireNonNull(packageName); |
| mNetworkMappings.putInt(packageName, preference); |
| return this; |
| } |
| |
| /** |
| * Remove a network preference for a given package. |
| * |
| * @param packageName full package name (e.g.: "com.google.apps.contacts") of the app to |
| * remove a preference for. |
| * @return The builder to facilitate chaining. |
| */ |
| @NonNull |
| public Builder clearNetworkPreference(@NonNull final String packageName) { |
| Objects.requireNonNull(packageName); |
| mNetworkMappings.remove(packageName); |
| return this; |
| } |
| |
| /** |
| * Build {@link OemNetworkPreferences} return the current OEM network preferences. |
| */ |
| @NonNull |
| public OemNetworkPreferences build() { |
| return new OemNetworkPreferences(mNetworkMappings); |
| } |
| } |
| |
| private static Map<String, Integer> convertToUnmodifiableMap(@NonNull final Bundle bundle) { |
| final Map<String, Integer> networkPreferences = new HashMap<>(); |
| for (final String key : bundle.keySet()) { |
| networkPreferences.put(key, bundle.getInt(key)); |
| } |
| return Collections.unmodifiableMap(networkPreferences); |
| } |
| |
| /** @hide */ |
| @IntDef(prefix = "OEM_NETWORK_PREFERENCE_", value = { |
| OEM_NETWORK_PREFERENCE_TEST_ONLY, |
| OEM_NETWORK_PREFERENCE_TEST, |
| OEM_NETWORK_PREFERENCE_UNINITIALIZED, |
| 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 |
| * |
| * @hide |
| */ |
| @NonNull |
| public static String oemNetworkPreferenceToString(@OemNetworkPreference int value) { |
| switch (value) { |
| case OEM_NETWORK_PREFERENCE_TEST_ONLY: |
| return "OEM_NETWORK_PREFERENCE_TEST_ONLY"; |
| case OEM_NETWORK_PREFERENCE_TEST: |
| return "OEM_NETWORK_PREFERENCE_TEST"; |
| case OEM_NETWORK_PREFERENCE_UNINITIALIZED: |
| return "OEM_NETWORK_PREFERENCE_UNINITIALIZED"; |
| 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.writeBundle(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.readBundle(getClass().getClassLoader())); |
| } |
| }; |
| } |