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

Commit 59a06a05 authored by Remi NGUYEN VAN's avatar Remi NGUYEN VAN
Browse files

Fix API in CaptivePortal, StaticIpConfiguration 

 - Add documentation to CaptivePortal#logEvent
 - Add paragraph breaks to StaticIpConfiguration class javadoc
 - Format javadoc for API documentation
 - Move setters to a builder and hide fields for apps targeting P or
   older
 - Document StaticIpConfiguration getters and builder setters
 - Add documentation for StaticIpConfiguration#getRoutes

Bug: 129362244
Bug: 129433304
Test: built, flashed, booted, WiFi working
Test: atest FrameworksNetTests NetworkStackTests
Change-Id: Ia66c1097f01ca87d02eba3456547aedb1e480186
parent 1859ae7e

api/system-current.txt

+9 −3
Original line number Diff line number Diff line
@@ -3276,13 +3276,19 @@ package android.net { 
    method @Nullable public java.net.InetAddress getGateway();

    method @Nullable public android.net.LinkAddress getIpAddress();

    method @NonNull public java.util.List<android.net.RouteInfo> getRoutes(@Nullable String);

    method public void setDomains(@Nullable String);

    method public void setGateway(@Nullable java.net.InetAddress);

    method public void setIpAddress(@Nullable android.net.LinkAddress);

    method public void writeToParcel(android.os.Parcel, int);

    field public static final android.os.Parcelable.Creator<android.net.StaticIpConfiguration> CREATOR;

  }













  public static final class StaticIpConfiguration.Builder {













    ctor public StaticIpConfiguration.Builder();













    method @NonNull public android.net.StaticIpConfiguration build();













    method @NonNull public android.net.StaticIpConfiguration.Builder setDnsServers(@NonNull Iterable<java.net.InetAddress>);













    method @NonNull public android.net.StaticIpConfiguration.Builder setDomains(@Nullable String);













    method @NonNull public android.net.StaticIpConfiguration.Builder setGateway(@Nullable java.net.InetAddress);













    method @NonNull public android.net.StaticIpConfiguration.Builder setIpAddress(@Nullable android.net.LinkAddress);













  }



























  public class TrafficStats {















    method public static void setThreadStatsTagApp();















    method public static void setThreadStatsTagBackup();

































api/test-current.txt



+9
−3




























Original line number
Diff line number
Diff line








@@ -696,13 +696,19 @@ package android.net {













    method @Nullable public java.net.InetAddress getGateway();















    method @Nullable public android.net.LinkAddress getIpAddress();















    method @NonNull public java.util.List<android.net.RouteInfo> getRoutes(@Nullable String);













    method public void setDomains(@Nullable String);













    method public void setGateway(@Nullable java.net.InetAddress);













    method public void setIpAddress(@Nullable android.net.LinkAddress);















    method public void writeToParcel(android.os.Parcel, int);















    field public static final android.os.Parcelable.Creator<android.net.StaticIpConfiguration> CREATOR;















  }





























  public static final class StaticIpConfiguration.Builder {













    ctor public StaticIpConfiguration.Builder();













    method @NonNull public android.net.StaticIpConfiguration build();













    method @NonNull public android.net.StaticIpConfiguration.Builder setDnsServers(@NonNull Iterable<java.net.InetAddress>);













    method @NonNull public android.net.StaticIpConfiguration.Builder setDomains(@Nullable String);













    method @NonNull public android.net.StaticIpConfiguration.Builder setGateway(@Nullable java.net.InetAddress);













    method @NonNull public android.net.StaticIpConfiguration.Builder setIpAddress(@Nullable android.net.LinkAddress);













  }





























  public final class TestNetworkInterface implements android.os.Parcelable {















    ctor public TestNetworkInterface(android.os.ParcelFileDescriptor, String);















    method public int describeContents();

































core/java/android/net/CaptivePortal.java



+2
−0




























Original line number
Diff line number
Diff line








@@ -137,6 +137,8 @@ public class CaptivePortal implements Parcelable {





























    /**















     * Log a captive portal login event.













     * @param eventId one of the CAPTIVE_PORTAL_LOGIN_* constants in metrics_constants.proto.













     * @param packageName captive portal application package name.















     * @hide















     */















    @SystemApi

































core/java/android/net/DhcpResults.java



+6
−9




























Original line number
Diff line number
Diff line








@@ -72,15 +72,12 @@ public final class DhcpResults implements Parcelable {













     * Create a {@link StaticIpConfiguration} based on the DhcpResults.















     */















    public StaticIpConfiguration toStaticIpConfiguration() {













        final StaticIpConfiguration s = new StaticIpConfiguration();













        // All these except dnsServers are immutable, so no need to make copies.













        s.setIpAddress(ipAddress);













        s.setGateway(gateway);













        for (InetAddress addr : dnsServers) {













            s.addDnsServer(addr);













        }













        s.setDomains(domains);













        return s;













        return new StaticIpConfiguration.Builder()













                .setIpAddress(ipAddress)













                .setGateway(gateway)













                .setDnsServers(dnsServers)













                .setDomains(domains)













                .build();















    }































    public DhcpResults(StaticIpConfiguration source) {

































core/java/android/net/StaticIpConfiguration.java



+88
−23




























Original line number
Diff line number
Diff line








@@ -22,6 +22,7 @@ import android.annotation.SystemApi;













import android.annotation.TestApi;















import android.annotation.UnsupportedAppUsage;















import android.net.shared.InetAddressUtils;













import android.os.Build;















import android.os.Parcel;















import android.os.Parcelable;

























@@ -33,20 +34,19 @@ import java.util.Objects;













/**















 * Class that describes static IP configuration.















 *













 * This class is different from LinkProperties because it represents













 * <p>This class is different from {@link LinkProperties} because it represents















 * configuration intent. The general contract is that if we can represent















 * a configuration here, then we should be able to configure it on a network.















 * The intent is that it closely match the UI we have for configuring networks.















 *













 * In contrast, LinkProperties represents current state. It is much more













 * <p>In contrast, {@link LinkProperties} represents current state. It is much more















 * expressive. For example, it supports multiple IP addresses, multiple routes,















 * stacked interfaces, and so on. Because LinkProperties is so expressive,















 * using it to represent configuration intent as well as current state causes















 * problems. For example, we could unknowingly save a configuration that we are















 * not in fact capable of applying, or we could save a configuration that the















 * UI cannot display, which has the potential for malicious code to hide













 * hostile or unexpected configuration from the user: see, for example,













 * http://b/12663469 and http://b/16893413 .













 * hostile or unexpected configuration from the user.















 *















 * @hide















 */









@@ -54,24 +54,24 @@ import java.util.Objects;













@TestApi















public final class StaticIpConfiguration implements Parcelable {















    /** @hide */













    @UnsupportedAppUsage













    @UnsupportedAppUsage(maxTargetSdk = Build.VERSION_CODES.P)















    @Nullable















    public LinkAddress ipAddress;















    /** @hide */













    @UnsupportedAppUsage













    @UnsupportedAppUsage(maxTargetSdk = Build.VERSION_CODES.P)















    @Nullable















    public InetAddress gateway;















    /** @hide */













    @UnsupportedAppUsage













    @UnsupportedAppUsage(maxTargetSdk = Build.VERSION_CODES.P)















    @NonNull















    public final ArrayList<InetAddress> dnsServers;















    /** @hide */













    @UnsupportedAppUsage













    @UnsupportedAppUsage(maxTargetSdk = Build.VERSION_CODES.P)















    @Nullable















    public String domains;































    public StaticIpConfiguration() {













        dnsServers = new ArrayList<InetAddress>();













        dnsServers = new ArrayList<>();















    }































    public StaticIpConfiguration(@Nullable StaticIpConfiguration source) {









@@ -92,32 +92,96 @@ public final class StaticIpConfiguration implements Parcelable {













        domains = null;















    }





























    /**













     * Get the static IP address included in the configuration.













     */















    public @Nullable LinkAddress getIpAddress() {















        return ipAddress;















    }





























    public void setIpAddress(@Nullable LinkAddress ipAddress) {













        this.ipAddress = ipAddress;













    }



























    /**













     * Get the gateway included in the configuration.













     */















    public @Nullable InetAddress getGateway() {















        return gateway;















    }





























    public void setGateway(@Nullable InetAddress gateway) {













        this.gateway = gateway;













    }



























    /**













     * Get the DNS servers included in the configuration.













     */















    public @NonNull List<InetAddress> getDnsServers() {















        return dnsServers;















    }





























    /**













     * Get a {@link String} listing in priority order of the comma separated domains to search when













     * resolving host names on the link.













     */















    public @Nullable String getDomains() {















        return domains;















    }





























    public void setDomains(@Nullable String newDomains) {













        domains = newDomains;













    /**













     * Helper class to build a new instance of {@link StaticIpConfiguration}.













     */













    public static final class Builder {













        private LinkAddress mIpAddress;













        private InetAddress mGateway;













        private Iterable<InetAddress> mDnsServers;













        private String mDomains;



























        /**













         * Set the IP address to be included in the configuration; null by default.













         * @return The {@link Builder} for chaining.













         */













        public @NonNull Builder setIpAddress(@Nullable LinkAddress ipAddress) {













            mIpAddress = ipAddress;













            return this;













        }



























        /**













         * Set the address of the gateway to be included in the configuration; null by default.













         * @return The {@link Builder} for chaining.













         */













        public @NonNull Builder setGateway(@Nullable InetAddress gateway) {













            mGateway = gateway;













            return this;













        }



























        /**













         * Set the addresses of the DNS servers included in the configuration; empty by default.













         * @return The {@link Builder} for chaining.













         */













        public @NonNull Builder setDnsServers(@NonNull Iterable<InetAddress> dnsServers) {













            mDnsServers = dnsServers;













            return this;













        }



























        /**













         * Sets the DNS domain search path to be used on the link; null by default.













         * @param newDomains A {@link String} containing the comma separated domains to search when













         *                   resolving host names on this link, in priority order.













         * @return The {@link Builder} for chaining.













         */













        public @NonNull Builder setDomains(@Nullable String newDomains) {













            mDomains = newDomains;













            return this;













        }



























        /**













         * Create a {@link StaticIpConfiguration} from the parameters in this {@link Builder}.













         * @return The newly created StaticIpConfiguration.













         */













        public @NonNull StaticIpConfiguration build() {













            final StaticIpConfiguration config = new StaticIpConfiguration();













            config.ipAddress = mIpAddress;













            config.gateway = mGateway;













            for (InetAddress server : mDnsServers) {













                config.dnsServers.add(server);













            }













            config.domains = mDomains;













            return config;













        }















    }































    /**









@@ -129,16 +193,17 @@ public final class StaticIpConfiguration implements Parcelable {





























    /**















     * Returns the network routes specified by this object. Will typically include a













     * directly-connected route for the IP address's local subnet and a default route. If the













     * default gateway is not covered by the directly-connected route, it will also contain a host













     * route to the gateway as well. This configuration is arguably invalid, but it used to work













     * in K and earlier, and other OSes appear to accept it.













     * directly-connected route for the IP address's local subnet and a default route.













     * @param iface Interface to include in the routes.















     */















    public @NonNull List<RouteInfo> getRoutes(@Nullable String iface) {















        List<RouteInfo> routes = new ArrayList<RouteInfo>(3);















        if (ipAddress != null) {















            RouteInfo connectedRoute = new RouteInfo(ipAddress, null, iface);















            routes.add(connectedRoute);













            // If the default gateway is not covered by the directly-connected route, also add a













            // host route to the gateway as well. This configuration is arguably invalid, but it













            // used to work in K and earlier, and other OSes appear to accept it.















            if (gateway != null && !connectedRoute.matches(gateway)) {















                routes.add(RouteInfo.makeHostRoute(gateway, iface));















            }