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

Commit 417a3b0a authored by lesl's avatar lesl
Browse files

wifi: API Review: API changes to SoftApConfiguration.Builder 

1. enableClientControlByUser should be renamed
to setClientControlByUserEnabled.
2. setShutdownTimeoutMillis(int) should take a long,
same for getter. Millisecond durations are always long.
3. Separate setClientList into two methods

Bug: 150855680
Test: atest frameworks/base/wifi/tests/
Change-Id: Ib065993748e186790290d3e50f4f28a09146fd65
parent 717f5ca8

api/system-current.txt

+5 −4
Original line number Diff line number Diff line
@@ -7157,7 +7157,7 @@ package android.net.wifi { 
    method @NonNull public java.util.List<android.net.MacAddress> getBlockedClientList();

    method public int getChannel();

    method public int getMaxNumberOfClients();

    method public int getShutdownTimeoutMillis();

    method public long getShutdownTimeoutMillis();

    method public boolean isAutoShutdownEnabled();

    method public boolean isClientControlByUserEnabled();

    method @Nullable public android.net.wifi.WifiConfiguration toWifiConfiguration();
@@ -7171,16 +7171,17 @@ package android.net.wifi { 
    ctor public SoftApConfiguration.Builder();

    ctor public SoftApConfiguration.Builder(@NonNull android.net.wifi.SoftApConfiguration);

    method @NonNull public android.net.wifi.SoftApConfiguration build();

    method @NonNull public android.net.wifi.SoftApConfiguration.Builder enableClientControlByUser(boolean);

    method @NonNull public android.net.wifi.SoftApConfiguration.Builder setAllowedClientList(@NonNull java.util.List<android.net.MacAddress>);

    method @NonNull public android.net.wifi.SoftApConfiguration.Builder setAutoShutdownEnabled(boolean);

    method @NonNull public android.net.wifi.SoftApConfiguration.Builder setBand(int);

    method @NonNull public android.net.wifi.SoftApConfiguration.Builder setBlockedClientList(@NonNull java.util.List<android.net.MacAddress>);

    method @NonNull public android.net.wifi.SoftApConfiguration.Builder setBssid(@Nullable android.net.MacAddress);

    method @NonNull public android.net.wifi.SoftApConfiguration.Builder setChannel(int, int);

    method @NonNull public android.net.wifi.SoftApConfiguration.Builder setClientList(@NonNull java.util.List<android.net.MacAddress>, @NonNull java.util.List<android.net.MacAddress>);

    method @NonNull public android.net.wifi.SoftApConfiguration.Builder setClientControlByUserEnabled(boolean);

    method @NonNull public android.net.wifi.SoftApConfiguration.Builder setHiddenSsid(boolean);

    method @NonNull public android.net.wifi.SoftApConfiguration.Builder setMaxNumberOfClients(@IntRange(from=0) int);

    method @NonNull public android.net.wifi.SoftApConfiguration.Builder setPassphrase(@Nullable String, int);

    method @NonNull public android.net.wifi.SoftApConfiguration.Builder setShutdownTimeoutMillis(@IntRange(from=0) int);

    method @NonNull public android.net.wifi.SoftApConfiguration.Builder setShutdownTimeoutMillis(@IntRange(from=0) long);

    method @NonNull public android.net.wifi.SoftApConfiguration.Builder setSsid(@Nullable String);

  }

































wifi/java/android/net/wifi/SoftApConfiguration.java



+49
−35




























Original line number
Diff line number
Diff line








@@ -35,7 +35,6 @@ import java.lang.annotation.RetentionPolicy;













import java.nio.charset.CharsetEncoder;















import java.nio.charset.StandardCharsets;















import java.util.ArrayList;













import java.util.Iterator;















import java.util.List;















import java.util.Objects;


























@@ -211,7 +210,7 @@ public final class SoftApConfiguration implements Parcelable {













     * Delay in milliseconds before shutting down soft AP when















     * there are no connected devices.















     */













    private final int mShutdownTimeoutMillis;













    private final long mShutdownTimeoutMillis;































    /**















     * THe definition of security type OPEN.










@@ -247,7 +246,7 @@ public final class SoftApConfiguration implements Parcelable {













    private SoftApConfiguration(@Nullable String ssid, @Nullable MacAddress bssid,















            @Nullable String passphrase, boolean hiddenSsid, @BandType int band, int channel,















            @SecurityType int securityType, int maxNumberOfClients, boolean shutdownTimeoutEnabled,













            int shutdownTimeoutMillis, boolean clientControlByUser,













            long shutdownTimeoutMillis, boolean clientControlByUser,















            @NonNull List<MacAddress> blockedList, @NonNull List<MacAddress> allowedList) {















        mSsid = ssid;















        mBssid = bssid;










@@ -327,7 +326,7 @@ public final class SoftApConfiguration implements Parcelable {













        dest.writeInt(mSecurityType);















        dest.writeInt(mMaxNumberOfClients);















        dest.writeBoolean(mAutoShutdownEnabled);













        dest.writeInt(mShutdownTimeoutMillis);













        dest.writeLong(mShutdownTimeoutMillis);















        dest.writeBoolean(mClientControlByUser);















        dest.writeTypedList(mBlockedClientList);















        dest.writeTypedList(mAllowedClientList);









@@ -346,7 +345,7 @@ public final class SoftApConfiguration implements Parcelable {













                    in.readString(),















                    in.readParcelable(MacAddress.class.getClassLoader()),















                    in.readString(), in.readBoolean(), in.readInt(), in.readInt(), in.readInt(),













                    in.readInt(), in.readBoolean(), in.readInt(), in.readBoolean(),













                    in.readInt(), in.readBoolean(), in.readLong(), in.readBoolean(),















                    in.createTypedArrayList(MacAddress.CREATOR),















                    in.createTypedArrayList(MacAddress.CREATOR));















        }










@@ -454,19 +453,19 @@ public final class SoftApConfiguration implements Parcelable {













    /**















     * Returns the shutdown timeout in milliseconds.















     * The Soft AP will shutdown when there are no devices associated to it for













     * the timeout duration. See {@link Builder#setShutdownTimeoutMillis(int)}.













     * the timeout duration. See {@link Builder#setShutdownTimeoutMillis(long)}.















     *















     * @hide















     */















    @SystemApi













    public int getShutdownTimeoutMillis() {













    public long getShutdownTimeoutMillis() {















        return mShutdownTimeoutMillis;















    }































    /**















     * Returns a flag indicating whether clients need to be pre-approved by the user.















     * (true: authorization required) or not (false: not required).













     * {@link Builder#enableClientControlByUser(Boolean)}.













     * {@link Builder#setClientControlByUserEnabled(Boolean)}.















     *















     * @hide















     */









@@ -478,7 +477,7 @@ public final class SoftApConfiguration implements Parcelable {













    /**















     * Returns List of clients which aren't allowed to associate to the AP.















     *













     * Clients are configured using {@link Builder#setClientList(List, List)}













     * Clients are configured using {@link Builder#setBlockedClientList(List)}















     *















     * @hide















     */









@@ -490,7 +489,7 @@ public final class SoftApConfiguration implements Parcelable {





























    /**















     * List of clients which are allowed to associate to the AP.













     * Clients are configured using {@link Builder#setClientList(List, List)}













     * Clients are configured using {@link Builder#setAllowedClientList(List)}















     *















     * @hide















     */










@@ -575,7 +574,7 @@ public final class SoftApConfiguration implements Parcelable {













        private int mMaxNumberOfClients;















        private int mSecurityType;















        private boolean mAutoShutdownEnabled;













        private int mShutdownTimeoutMillis;













        private long mShutdownTimeoutMillis;















        private boolean mClientControlByUser;















        private List<MacAddress> mBlockedClientList;















        private List<MacAddress> mAllowedClientList;










@@ -627,6 +626,11 @@ public final class SoftApConfiguration implements Parcelable {













         */















        @NonNull















        public SoftApConfiguration build() {













            for (MacAddress client : mAllowedClientList) {













                if (mBlockedClientList.contains(client)) {













                    throw new IllegalArgumentException("A MacAddress exist in both client list");













                }













            }















            return new SoftApConfiguration(mSsid, mBssid, mPassphrase,















                    mHiddenSsid, mBand, mChannel, mSecurityType, mMaxNumberOfClients,















                    mAutoShutdownEnabled, mShutdownTimeoutMillis, mClientControlByUser,










@@ -835,7 +839,7 @@ public final class SoftApConfiguration implements Parcelable {













         * @param enable true to enable, false to disable.















         * @return Builder for chaining.















         *













         * @see #setShutdownTimeoutMillis(int)













         * @see #setShutdownTimeoutMillis(long)















         */















        @NonNull















        public Builder setAutoShutdownEnabled(boolean enable) {









@@ -862,7 +866,7 @@ public final class SoftApConfiguration implements Parcelable {













         * @see #setAutoShutdownEnabled(boolean)















         */















        @NonNull













        public Builder setShutdownTimeoutMillis(@IntRange(from = 0) int timeoutMillis) {













        public Builder setShutdownTimeoutMillis(@IntRange(from = 0) long timeoutMillis) {















            if (timeoutMillis < 0) {















                throw new IllegalArgumentException("Invalid timeout value");















            }









@@ -878,7 +882,7 @@ public final class SoftApConfiguration implements Parcelable {













         *















         * If manual user control is enabled then clients will be accepted, rejected, or require















         * a user approval based on the configuration provided by













         * {@link #setClientList(List, List)}.













         * {@link #setBlockedClientList(List)} and {@link #setAllowedClientList(List)}.















         *















         * <p>















         * This method requires hardware support. Hardware support can be determined using









@@ -898,26 +902,21 @@ public final class SoftApConfiguration implements Parcelable {













         * @return Builder for chaining.















         */















        @NonNull













        public Builder enableClientControlByUser(boolean enabled) {













        public Builder setClientControlByUserEnabled(boolean enabled) {















            mClientControlByUser = enabled;















            return this;















        }















































        /**













         * This method together with {@link enableClientControlByUser(boolean)} control client













         * connections to the AP. If {@link enableClientControlByUser(false)} is configured than













         * This method together with {@link setClientControlByUserEnabled(boolean)} control client













         * connections to the AP. If client control by user is disabled using the above method then















         * this API has no effect and clients are allowed to associate to the AP (within limit of















         * max number of clients).















         *













         * If {@link enableClientControlByUser(true)} is configured then this API configures













         * 2 lists:













         * <ul>













         * <li>List of clients which are blocked. These are rejected.</li>













         * <li>List of clients which are explicitly allowed. These are auto-accepted.</li>













         * </ul>













         * If client control by user is enabled then this API configures the list of clients













         * which are explicitly allowed. These are auto-accepted.















         *













         * <p>















         * All other clients which attempt to associate, whose MAC addresses are on neither list,















         * are:















         * <ul>









@@ -926,24 +925,39 @@ public final class SoftApConfiguration implements Parcelable {













         * is issued (which allows the user to add them to the allowed client list if desired).<li>















         * </ul>















         *













         * @param blockedClientList list of clients which are not allowed to associate to the AP.















         * @param allowedClientList list of clients which are allowed to associate to the AP















         *                          without user pre-approval.















         * @return Builder for chaining.















         */















        @NonNull













        public Builder setClientList(@NonNull List<MacAddress> blockedClientList,













                @NonNull List<MacAddress> allowedClientList) {













            mBlockedClientList = new ArrayList<>(blockedClientList);













        public Builder setAllowedClientList(@NonNull List<MacAddress> allowedClientList) {















            mAllowedClientList = new ArrayList<>(allowedClientList);













            Iterator<MacAddress> iterator = mAllowedClientList.iterator();













            while (iterator.hasNext()) {













                MacAddress client = iterator.next();













                int index = mBlockedClientList.indexOf(client);













                if (index != -1) {













                    throw new IllegalArgumentException("A MacAddress exist in both list");













                }













            return this;















        }



























        /**













         * This method together with {@link setClientControlByUserEnabled(boolean)} control client













         * connections to the AP. If client control by user is disabled using the above method then













         * this API has no effect and clients are allowed to associate to the AP (within limit of













         * max number of clients).













         *













         * If client control by user is enabled then this API this API configures the list of













         * clients which are blocked. These are rejected.













         *













         * All other clients which attempt to associate, whose MAC addresses are on neither list,













         * are:













         * <ul>













         * <li>Rejected</li>













         * <li>A callback {@link WifiManager.SoftApCallback#onBlockedClientConnecting(WifiClient)}













         * is issued (which allows the user to add them to the allowed client list if desired).<li>













         * </ul>













         *













         * @param blockedClientList list of clients which are not allowed to associate to the AP.













         * @return Builder for chaining.













         */













        @NonNull













        public Builder setBlockedClientList(@NonNull List<MacAddress> blockedClientList) {













            mBlockedClientList = new ArrayList<>(blockedClientList);















            return this;















        }















    }

































wifi/java/android/net/wifi/WifiManager.java



+7
−5




























Original line number
Diff line number
Diff line








@@ -727,8 +727,9 @@ public class WifiManager {





























    /**















     *  If Soft Ap client is blocked, this reason code means that client doesn't exist in the













     *  specified configuration {@link SoftApConfiguration.Builder#setClientList(List, List)}













     *  and the {@link SoftApConfiguration.Builder#enableClientControlByUser(true)}













     *  specified configuration {@link SoftApConfiguration.Builder#setBlockedClientList(List)}













     *  and {@link SoftApConfiguration.Builder#setAllowedClientList(List)}













     *  and the {@link SoftApConfiguration.Builder#setClientControlByUserEnabled(boolean)}















     *  is configured as well.















     *  @hide















     */










@@ -3406,9 +3407,10 @@ public class WifiManager {













     * If the API is called while the tethered soft AP is enabled, the configuration will apply to















     * the current soft AP if the new configuration only includes















     * {@link SoftApConfiguration.Builder#setMaxNumberOfClients(int)}













     * or {@link SoftApConfiguration.Builder#setShutdownTimeoutMillis(int)}













     * or {@link SoftApConfiguration.Builder#enableClientControlByUser(boolean)}













     * or {@link SoftApConfiguration.Builder#setClientList(List, List)}.













     * or {@link SoftApConfiguration.Builder#setShutdownTimeoutMillis(long)}













     * or {@link SoftApConfiguration.Builder#setClientControlByUserEnabled(boolean)}













     * or {@link SoftApConfiguration.Builder#setBlockedClientList(List)}













     * or {@link SoftApConfiguration.Builder#setAllowedClientList(List)}















     *















     * Otherwise, the configuration changes will be applied when the Soft AP is next started















     * (the framework will not stop/start the AP).

































wifi/tests/src/android/net/wifi/SoftApConfigurationTest.java



+6
−3




























Original line number
Diff line number
Diff line








@@ -127,8 +127,9 @@ public class SoftApConfigurationTest {













                .setMaxNumberOfClients(10)















                .setAutoShutdownEnabled(true)















                .setShutdownTimeoutMillis(500000)













                .enableClientControlByUser(true)













                .setClientList(testBlockedClientList, testAllowedClientList)













                .setClientControlByUserEnabled(true)













                .setBlockedClientList(testBlockedClientList)













                .setAllowedClientList(testAllowedClientList)















                .build();















        assertThat(original.getPassphrase()).isEqualTo("secretsecret");















        assertThat(original.getSecurityType()).isEqualTo(










@@ -264,7 +265,9 @@ public class SoftApConfigurationTest {













        ArrayList<MacAddress> testBlockedClientList = new ArrayList<>();















        testBlockedClientList.add(testMacAddress_1);















        SoftApConfiguration.Builder configBuilder = new SoftApConfiguration.Builder();













        configBuilder.setClientList(testBlockedClientList, testAllowedClientList);













        configBuilder.setBlockedClientList(testBlockedClientList)













                .setAllowedClientList(testAllowedClientList)













                .build();















    }































    @Test