android-34/android/net/ProfileNetworkPreference.java - platform/prebuilts/fullsdk/sources - Git at Google

 /*
  * 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 static android.annotation.SystemApi.Client.MODULE_LIBRARIES;
 import static android.net.ConnectivityManager.PROFILE_NETWORK_PREFERENCE_DEFAULT;
 import static android.net.NetworkCapabilities.NET_ENTERPRISE_ID_1;
 import static android.net.NetworkCapabilities.NET_ENTERPRISE_ID_5;

 import android.annotation.NonNull;
 import android.annotation.SystemApi;
 import android.net.ConnectivityManager.ProfileNetworkPreferencePolicy;
 import android.os.Parcel;
 import android.os.Parcelable;

 import java.util.Arrays;
 import java.util.Objects;

 /**
  * Network preferences to be set for the user profile
  * {@link ProfileNetworkPreferencePolicy}.
  * @hide
  */
 @SystemApi(client = MODULE_LIBRARIES)
 public final class ProfileNetworkPreference implements Parcelable {
     private final @ProfileNetworkPreferencePolicy int mPreference;
     private final @NetworkCapabilities.EnterpriseId int mPreferenceEnterpriseId;
     private int[] mIncludedUids = new int[0];
     private int[] mExcludedUids = new int[0];

     private ProfileNetworkPreference(int preference, int[] includedUids,
             int[] excludedUids,
             @NetworkCapabilities.EnterpriseId int preferenceEnterpriseId) {
         mPreference = preference;
         mPreferenceEnterpriseId = preferenceEnterpriseId;
         if (includedUids != null) {
             mIncludedUids = includedUids.clone();
         } else {
             mIncludedUids = new int[0];
         }

         if (excludedUids != null) {
             mExcludedUids = excludedUids.clone();
         } else {
             mExcludedUids = new int[0];
         }
     }

     private ProfileNetworkPreference(Parcel in) {
         mPreference = in.readInt();
         in.readIntArray(mIncludedUids);
         in.readIntArray(mExcludedUids);
         mPreferenceEnterpriseId = in.readInt();
     }

     public int getPreference() {
         return mPreference;
     }

     /**
      * Get the array of UIDs subject to this preference.
      *
      * Included UIDs and Excluded UIDs can't both be non-empty.
      * if both are empty, it means this request applies to all uids in the user profile.
      * if included is not empty, then only included UIDs are applied.
      * if excluded is not empty, then it is all uids in the user profile except these UIDs.
      * @return Array of uids included for the profile preference.
      * @see #getExcludedUids()
      */
     public @NonNull int[] getIncludedUids() {
         return mIncludedUids.clone();
     }

     /**
      * Get the array of UIDS excluded from this preference.
      *
      * <ul>Included UIDs and Excluded UIDs can't both be non-empty.</ul>
      * <ul>If both are empty, it means this request applies to all uids in the user profile.</ul>
      * <ul>If included is not empty, then only included UIDs are applied.</ul>
      * <ul>If excluded is not empty, then it is all uids in the user profile except these UIDs.</ul>
      * @return Array of uids not included for the profile preference.
      * @see #getIncludedUids()
      */
     public @NonNull int[] getExcludedUids() {
         return mExcludedUids.clone();
     }

     /**
      * Get preference enterprise identifier.
      *
      * Preference enterprise identifier will be used to create different network preferences
      * within enterprise preference category.
      * Valid values starts from PROFILE_NETWORK_PREFERENCE_ENTERPRISE_ID_1 to
      * NetworkCapabilities.NET_ENTERPRISE_ID_5.
      * Preference identifier is not applicable if preference is set as
      * PROFILE_NETWORK_PREFERENCE_DEFAULT. Default value is
      * NetworkCapabilities.NET_ENTERPRISE_ID_1.
      * @return Preference enterprise identifier.
      *
      */
     public @NetworkCapabilities.EnterpriseId int getPreferenceEnterpriseId() {
         return mPreferenceEnterpriseId;
     }

     @Override
     public String toString() {
         return "ProfileNetworkPreference{"
                 + "mPreference=" + getPreference()
                 + "mIncludedUids=" + Arrays.toString(mIncludedUids)
                 + "mExcludedUids=" + Arrays.toString(mExcludedUids)
                 + "mPreferenceEnterpriseId=" + mPreferenceEnterpriseId
                 + '}';
     }

     @Override
     public boolean equals(Object o) {
         if (this == o) return true;
         if (o == null || getClass() != o.getClass()) return false;
         final ProfileNetworkPreference that = (ProfileNetworkPreference) o;
         return mPreference == that.mPreference
                 && (Arrays.equals(mIncludedUids, that.mIncludedUids))
                 && (Arrays.equals(mExcludedUids, that.mExcludedUids))
                 && mPreferenceEnterpriseId == that.mPreferenceEnterpriseId;
     }

     @Override
     public int hashCode() {
         return mPreference
                 + mPreferenceEnterpriseId * 2
                 + (Arrays.hashCode(mIncludedUids) * 11)
                 + (Arrays.hashCode(mExcludedUids) * 13);
     }

     /**
      * Builder used to create {@link ProfileNetworkPreference} objects.
      * Specify the preferred Network preference
      */
     public static final class Builder {
         private @ProfileNetworkPreferencePolicy int mPreference =
                 PROFILE_NETWORK_PREFERENCE_DEFAULT;
         private int[] mIncludedUids = new int[0];
         private int[] mExcludedUids = new int[0];
         private int mPreferenceEnterpriseId;

         /**
          * Constructs an empty Builder with PROFILE_NETWORK_PREFERENCE_DEFAULT profile preference
          */
         public Builder() {}

         /**
          * Set the profile network preference
          * See the documentation for the individual preferences for a description of the supported
          * behaviors. Default value is PROFILE_NETWORK_PREFERENCE_DEFAULT.
          * @param preference  the desired network preference to use
          * @return The builder to facilitate chaining.
          */
         @NonNull
         public Builder setPreference(@ProfileNetworkPreferencePolicy int preference) {
             mPreference = preference;
             return this;
         }

         /**
          * This is a array of uids for which profile perefence is set.
          * Empty would mean that this preference applies to all uids in the profile.
          * @see #setExcludedUids(int[])
          * Included UIDs and Excluded UIDs can't both be non-empty.
          * if both are empty, it means this request applies to all uids in the user profile.
          * if included is not empty, then only included UIDs are applied.
          * if excluded is not empty, then it is all uids in the user profile except these UIDs.
          * @param uids  Array of uids that are included
          * @return The builder to facilitate chaining.
          */
         @NonNull
         public Builder setIncludedUids(@NonNull int[] uids) {
             Objects.requireNonNull(uids);
             mIncludedUids = uids.clone();
             return this;
         }


         /**
          * This is a array of uids that are excluded for the profile perefence.
          * @see #setIncludedUids(int[])
          * Included UIDs and Excluded UIDs can't both be non-empty.
          * if both are empty, it means this request applies to all uids in the user profile.
          * if included is not empty, then only included UIDs are applied.
          * if excluded is not empty, then it is all uids in the user profile except these UIDs.
          * @param uids  Array of uids that are not included
          * @return The builder to facilitate chaining.
          */
         @NonNull
         public Builder setExcludedUids(@NonNull int[] uids) {
             Objects.requireNonNull(uids);
             mExcludedUids = uids.clone();
             return this;
         }

         /**
          * Check if given preference enterprise identifier is valid
          *
          * Valid values starts from PROFILE_NETWORK_PREFERENCE_ENTERPRISE_ID_1 to
          * NetworkCapabilities.NET_ENTERPRISE_ID_5.
          * @return True if valid else false
          * @hide
          */
         private boolean isEnterpriseIdentifierValid(
                 @NetworkCapabilities.EnterpriseId int identifier) {
             if ((identifier >= NET_ENTERPRISE_ID_1)
                     && (identifier <= NET_ENTERPRISE_ID_5)) {
                 return true;
             }
             return false;
         }

         /**
          * Returns an instance of {@link ProfileNetworkPreference} created from the
          * fields set on this builder.
          */
         @NonNull
         public ProfileNetworkPreference  build() {
             if (mIncludedUids.length > 0 && mExcludedUids.length > 0) {
                 throw new IllegalArgumentException("Both includedUids and excludedUids "
                         + "cannot be nonempty");
             }

             if (((mPreference != PROFILE_NETWORK_PREFERENCE_DEFAULT)
                     && (!isEnterpriseIdentifierValid(mPreferenceEnterpriseId)))
                     || ((mPreference == PROFILE_NETWORK_PREFERENCE_DEFAULT)
                     && (mPreferenceEnterpriseId != 0))) {
                 throw new IllegalStateException("Invalid preference enterprise identifier");
             }
             return new ProfileNetworkPreference(mPreference, mIncludedUids,
                     mExcludedUids, mPreferenceEnterpriseId);
         }

         /**
          * Set the preference enterprise identifier.
          *
          * Preference enterprise identifier will be used to create different network preferences
          * within enterprise preference category.
          * Valid values starts from NetworkCapabilities.NET_ENTERPRISE_ID_1 to
          * NetworkCapabilities.NET_ENTERPRISE_ID_5.
          * Preference identifier is not applicable if preference is set as
          * PROFILE_NETWORK_PREFERENCE_DEFAULT. Default value is
          * NetworkCapabilities.NET_ENTERPRISE_ID_1.
          * @param preferenceId  preference sub level
          * @return The builder to facilitate chaining.
          */
         @NonNull
         public Builder setPreferenceEnterpriseId(
                 @NetworkCapabilities.EnterpriseId int preferenceId) {
             mPreferenceEnterpriseId = preferenceId;
             return this;
         }
     }

     @Override
     public void writeToParcel(@NonNull android.os.Parcel dest, int flags) {
         dest.writeInt(mPreference);
         dest.writeIntArray(mIncludedUids);
         dest.writeIntArray(mExcludedUids);
         dest.writeInt(mPreferenceEnterpriseId);
     }

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

     @NonNull
     public static final Creator<ProfileNetworkPreference> CREATOR =
             new Creator<ProfileNetworkPreference>() {
                 @Override
                 public ProfileNetworkPreference[] newArray(int size) {
                     return new ProfileNetworkPreference[size];
                 }

                 @Override
                 public ProfileNetworkPreference  createFromParcel(
                         @NonNull android.os.Parcel in) {
                     return new ProfileNetworkPreference(in);
                 }
             };
 }
	/*
	* 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 static android.annotation.SystemApi.Client.MODULE_LIBRARIES;
	import static android.net.ConnectivityManager.PROFILE_NETWORK_PREFERENCE_DEFAULT;
	import static android.net.NetworkCapabilities.NET_ENTERPRISE_ID_1;
	import static android.net.NetworkCapabilities.NET_ENTERPRISE_ID_5;

	import android.annotation.NonNull;
	import android.annotation.SystemApi;
	import android.net.ConnectivityManager.ProfileNetworkPreferencePolicy;
	import android.os.Parcel;
	import android.os.Parcelable;

	import java.util.Arrays;
	import java.util.Objects;

	/**
	* Network preferences to be set for the user profile
	* {@link ProfileNetworkPreferencePolicy}.
	* @hide
	*/
	@SystemApi(client = MODULE_LIBRARIES)
	public final class ProfileNetworkPreference implements Parcelable {
	private final @ProfileNetworkPreferencePolicy int mPreference;
	private final @NetworkCapabilities.EnterpriseId int mPreferenceEnterpriseId;
	private int[] mIncludedUids = new int[0];
	private int[] mExcludedUids = new int[0];

	private ProfileNetworkPreference(int preference, int[] includedUids,
	int[] excludedUids,
	@NetworkCapabilities.EnterpriseId int preferenceEnterpriseId) {
	mPreference = preference;
	mPreferenceEnterpriseId = preferenceEnterpriseId;
	if (includedUids != null) {
	mIncludedUids = includedUids.clone();
	} else {
	mIncludedUids = new int[0];
	}

	if (excludedUids != null) {
	mExcludedUids = excludedUids.clone();
	} else {
	mExcludedUids = new int[0];
	}
	}

	private ProfileNetworkPreference(Parcel in) {
	mPreference = in.readInt();
	in.readIntArray(mIncludedUids);
	in.readIntArray(mExcludedUids);
	mPreferenceEnterpriseId = in.readInt();
	}

	public int getPreference() {
	return mPreference;
	}

	/**
	* Get the array of UIDs subject to this preference.
	*
	* Included UIDs and Excluded UIDs can't both be non-empty.
	* if both are empty, it means this request applies to all uids in the user profile.
	* if included is not empty, then only included UIDs are applied.
	* if excluded is not empty, then it is all uids in the user profile except these UIDs.
	* @return Array of uids included for the profile preference.
	* @see #getExcludedUids()
	*/
	public @NonNull int[] getIncludedUids() {
	return mIncludedUids.clone();
	}

	/**
	* Get the array of UIDS excluded from this preference.
	*
	* <ul>Included UIDs and Excluded UIDs can't both be non-empty.</ul>
	* <ul>If both are empty, it means this request applies to all uids in the user profile.</ul>
	* <ul>If included is not empty, then only included UIDs are applied.</ul>
	* <ul>If excluded is not empty, then it is all uids in the user profile except these UIDs.</ul>
	* @return Array of uids not included for the profile preference.
	* @see #getIncludedUids()
	*/
	public @NonNull int[] getExcludedUids() {
	return mExcludedUids.clone();
	}

	/**
	* Get preference enterprise identifier.
	*
	* Preference enterprise identifier will be used to create different network preferences
	* within enterprise preference category.
	* Valid values starts from PROFILE_NETWORK_PREFERENCE_ENTERPRISE_ID_1 to
	* NetworkCapabilities.NET_ENTERPRISE_ID_5.
	* Preference identifier is not applicable if preference is set as
	* PROFILE_NETWORK_PREFERENCE_DEFAULT. Default value is
	* NetworkCapabilities.NET_ENTERPRISE_ID_1.
	* @return Preference enterprise identifier.
	*
	*/
	public @NetworkCapabilities.EnterpriseId int getPreferenceEnterpriseId() {
	return mPreferenceEnterpriseId;
	}

	@Override
	public String toString() {
	return "ProfileNetworkPreference{"
	+ "mPreference=" + getPreference()
	+ "mIncludedUids=" + Arrays.toString(mIncludedUids)
	+ "mExcludedUids=" + Arrays.toString(mExcludedUids)
	+ "mPreferenceEnterpriseId=" + mPreferenceEnterpriseId
	+ '}';
	}

	@Override
	public boolean equals(Object o) {
	if (this == o) return true;
	if (o == null \|\| getClass() != o.getClass()) return false;
	final ProfileNetworkPreference that = (ProfileNetworkPreference) o;
	return mPreference == that.mPreference
	&& (Arrays.equals(mIncludedUids, that.mIncludedUids))
	&& (Arrays.equals(mExcludedUids, that.mExcludedUids))
	&& mPreferenceEnterpriseId == that.mPreferenceEnterpriseId;
	}

	@Override
	public int hashCode() {
	return mPreference
	+ mPreferenceEnterpriseId * 2
	+ (Arrays.hashCode(mIncludedUids) * 11)
	+ (Arrays.hashCode(mExcludedUids) * 13);
	}

	/**
	* Builder used to create {@link ProfileNetworkPreference} objects.
	* Specify the preferred Network preference
	*/
	public static final class Builder {
	private @ProfileNetworkPreferencePolicy int mPreference =
	PROFILE_NETWORK_PREFERENCE_DEFAULT;
	private int[] mIncludedUids = new int[0];
	private int[] mExcludedUids = new int[0];
	private int mPreferenceEnterpriseId;

	/**
	* Constructs an empty Builder with PROFILE_NETWORK_PREFERENCE_DEFAULT profile preference
	*/
	public Builder() {}

	/**
	* Set the profile network preference
	* See the documentation for the individual preferences for a description of the supported
	* behaviors. Default value is PROFILE_NETWORK_PREFERENCE_DEFAULT.
	* @param preference the desired network preference to use
	* @return The builder to facilitate chaining.
	*/
	@NonNull
	public Builder setPreference(@ProfileNetworkPreferencePolicy int preference) {
	mPreference = preference;
	return this;
	}

	/**
	* This is a array of uids for which profile perefence is set.
	* Empty would mean that this preference applies to all uids in the profile.
	* @see #setExcludedUids(int[])
	* Included UIDs and Excluded UIDs can't both be non-empty.
	* if both are empty, it means this request applies to all uids in the user profile.
	* if included is not empty, then only included UIDs are applied.
	* if excluded is not empty, then it is all uids in the user profile except these UIDs.
	* @param uids Array of uids that are included
	* @return The builder to facilitate chaining.
	*/
	@NonNull
	public Builder setIncludedUids(@NonNull int[] uids) {
	Objects.requireNonNull(uids);
	mIncludedUids = uids.clone();
	return this;
	}


	/**
	* This is a array of uids that are excluded for the profile perefence.
	* @see #setIncludedUids(int[])
	* Included UIDs and Excluded UIDs can't both be non-empty.
	* if both are empty, it means this request applies to all uids in the user profile.
	* if included is not empty, then only included UIDs are applied.
	* if excluded is not empty, then it is all uids in the user profile except these UIDs.
	* @param uids Array of uids that are not included
	* @return The builder to facilitate chaining.
	*/
	@NonNull
	public Builder setExcludedUids(@NonNull int[] uids) {
	Objects.requireNonNull(uids);
	mExcludedUids = uids.clone();
	return this;
	}

	/**
	* Check if given preference enterprise identifier is valid
	*
	* Valid values starts from PROFILE_NETWORK_PREFERENCE_ENTERPRISE_ID_1 to
	* NetworkCapabilities.NET_ENTERPRISE_ID_5.
	* @return True if valid else false
	* @hide
	*/
	private boolean isEnterpriseIdentifierValid(
	@NetworkCapabilities.EnterpriseId int identifier) {
	if ((identifier >= NET_ENTERPRISE_ID_1)
	&& (identifier <= NET_ENTERPRISE_ID_5)) {
	return true;
	}
	return false;
	}

	/**
	* Returns an instance of {@link ProfileNetworkPreference} created from the
	* fields set on this builder.
	*/
	@NonNull
	public ProfileNetworkPreference build() {
	if (mIncludedUids.length > 0 && mExcludedUids.length > 0) {
	throw new IllegalArgumentException("Both includedUids and excludedUids "
	+ "cannot be nonempty");
	}

	if (((mPreference != PROFILE_NETWORK_PREFERENCE_DEFAULT)
	&& (!isEnterpriseIdentifierValid(mPreferenceEnterpriseId)))
	\|\| ((mPreference == PROFILE_NETWORK_PREFERENCE_DEFAULT)
	&& (mPreferenceEnterpriseId != 0))) {
	throw new IllegalStateException("Invalid preference enterprise identifier");
	}
	return new ProfileNetworkPreference(mPreference, mIncludedUids,
	mExcludedUids, mPreferenceEnterpriseId);
	}

	/**
	* Set the preference enterprise identifier.
	*
	* Preference enterprise identifier will be used to create different network preferences
	* within enterprise preference category.
	* Valid values starts from NetworkCapabilities.NET_ENTERPRISE_ID_1 to
	* NetworkCapabilities.NET_ENTERPRISE_ID_5.
	* Preference identifier is not applicable if preference is set as
	* PROFILE_NETWORK_PREFERENCE_DEFAULT. Default value is
	* NetworkCapabilities.NET_ENTERPRISE_ID_1.
	* @param preferenceId preference sub level
	* @return The builder to facilitate chaining.
	*/
	@NonNull
	public Builder setPreferenceEnterpriseId(
	@NetworkCapabilities.EnterpriseId int preferenceId) {
	mPreferenceEnterpriseId = preferenceId;
	return this;
	}
	}

	@Override
	public void writeToParcel(@NonNull android.os.Parcel dest, int flags) {
	dest.writeInt(mPreference);
	dest.writeIntArray(mIncludedUids);
	dest.writeIntArray(mExcludedUids);
	dest.writeInt(mPreferenceEnterpriseId);
	}

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

	@NonNull
	public static final Creator<ProfileNetworkPreference> CREATOR =
	new Creator<ProfileNetworkPreference>() {
	@Override
	public ProfileNetworkPreference[] newArray(int size) {
	return new ProfileNetworkPreference[size];
	}

	@Override
	public ProfileNetworkPreference createFromParcel(
	@NonNull android.os.Parcel in) {
	return new ProfileNetworkPreference(in);
	}
	};
	}