Merge changes I105589aa,I3674fd5b,I215962fa,I5ca97e26,Ib47a1a6d
* changes:
p2p: add valid string documentation for network name and passphrase
p2p: rename the annotation to match the API names.
p2p: add annotation for WifiP2pConfig.Builder public API
p2p: add annotation for WifiP2pConfig.Builder public API
p2p: add annotation for WifiP2pConfig.Builder public API
diff --git a/api/current.txt b/api/current.txt
index 9563ea7..7b1cb45 100644
--- a/api/current.txt
+++ b/api/current.txt
@@ -30406,13 +30406,13 @@
public static final class WifiP2pConfig.Builder {
ctor public WifiP2pConfig.Builder();
- method public android.net.wifi.p2p.WifiP2pConfig build();
- method public android.net.wifi.p2p.WifiP2pConfig.Builder enablePersistentMode(boolean);
- method public android.net.wifi.p2p.WifiP2pConfig.Builder setDeviceAddress(android.net.MacAddress);
- method public android.net.wifi.p2p.WifiP2pConfig.Builder setGroupOperatingBand(int);
- method public android.net.wifi.p2p.WifiP2pConfig.Builder setGroupOperatingFrequency(int);
- method public android.net.wifi.p2p.WifiP2pConfig.Builder setNetworkName(String);
- method public android.net.wifi.p2p.WifiP2pConfig.Builder setPassphrase(String);
+ method @NonNull public android.net.wifi.p2p.WifiP2pConfig build();
+ method @NonNull public android.net.wifi.p2p.WifiP2pConfig.Builder enablePersistentMode(boolean);
+ method @NonNull public android.net.wifi.p2p.WifiP2pConfig.Builder setDeviceAddress(@Nullable android.net.MacAddress);
+ method @NonNull public android.net.wifi.p2p.WifiP2pConfig.Builder setGroupOperatingBand(int);
+ method @NonNull public android.net.wifi.p2p.WifiP2pConfig.Builder setGroupOperatingFrequency(int);
+ method @NonNull public android.net.wifi.p2p.WifiP2pConfig.Builder setNetworkName(@NonNull String);
+ method @NonNull public android.net.wifi.p2p.WifiP2pConfig.Builder setPassphrase(@NonNull String);
}
public class WifiP2pDevice implements android.os.Parcelable {
diff --git a/wifi/java/android/net/wifi/p2p/WifiP2pConfig.java b/wifi/java/android/net/wifi/p2p/WifiP2pConfig.java
index 5e1f569..ba6caa0 100644
--- a/wifi/java/android/net/wifi/p2p/WifiP2pConfig.java
+++ b/wifi/java/android/net/wifi/p2p/WifiP2pConfig.java
@@ -17,6 +17,8 @@
package android.net.wifi.p2p;
import android.annotation.IntDef;
+import android.annotation.NonNull;
+import android.annotation.Nullable;
import android.annotation.UnsupportedAppUsage;
import android.net.MacAddress;
import android.net.wifi.WpsInfo;
@@ -76,7 +78,7 @@
GROUP_OWNER_BAND_5GHZ
})
@Retention(RetentionPolicy.SOURCE)
- public @interface GroupOwnerBandType {}
+ public @interface GroupOperatingBandType {}
/**
* Recognized Group Owner required band.
@@ -240,7 +242,7 @@
* @return The builder to facilitate chaining
* {@code builder.setXXX(..).setXXX(..)}.
*/
- public Builder setDeviceAddress(MacAddress deviceAddress) {
+ public @NonNull Builder setDeviceAddress(@Nullable MacAddress deviceAddress) {
if (deviceAddress == null) {
mDeviceAddress = MAC_ANY_ADDRESS;
} else {
@@ -255,7 +257,9 @@
* <p>
* A network name shall begin with "DIRECT-xy". x and y are selected
* from the following character set: upper case letters, lower case
- * letters and numbers.
+ * letters and numbers. Any byte values allowed for an SSID according to
+ * IEEE802.11-2012 [1] may be included after the string "DIRECT-xy"
+ * (including none).
* <p>
* Must be called - an empty network name or an network name
* not conforming to the P2P Group ID naming rule is not valid.
@@ -264,7 +268,7 @@
* @return The builder to facilitate chaining
* {@code builder.setXXX(..).setXXX(..)}.
*/
- public Builder setNetworkName(String networkName) {
+ public @NonNull Builder setNetworkName(@NonNull String networkName) {
if (TextUtils.isEmpty(networkName)) {
throw new IllegalArgumentException(
"network name must be non-empty.");
@@ -284,17 +288,24 @@
/**
* Specify the passphrase for creating or joining a group.
* <p>
+ * The passphrase must be an ASCII string whose length is between 8
+ * and 63.
+ * <p>
* Must be called - an empty passphrase is not valid.
*
* @param passphrase the passphrase of a group.
* @return The builder to facilitate chaining
* {@code builder.setXXX(..).setXXX(..)}.
*/
- public Builder setPassphrase(String passphrase) {
+ public @NonNull Builder setPassphrase(@NonNull String passphrase) {
if (TextUtils.isEmpty(passphrase)) {
throw new IllegalArgumentException(
"passphrase must be non-empty.");
}
+ if (passphrase.length() < 8 || passphrase.length() > 63) {
+ throw new IllegalArgumentException(
+ "The length of a passphrase must be between 8 and 63.");
+ }
mPassphrase = passphrase;
return this;
}
@@ -331,7 +342,7 @@
* @return The builder to facilitate chaining
* {@code builder.setXXX(..).setXXX(..)}.
*/
- public Builder setGroupOperatingBand(@GroupOwnerBandType int band) {
+ public @NonNull Builder setGroupOperatingBand(@GroupOperatingBandType int band) {
switch (band) {
case GROUP_OWNER_BAND_AUTO:
case GROUP_OWNER_BAND_2GHZ:
@@ -372,7 +383,7 @@
* @return The builder to facilitate chaining
* {@code builder.setXXX(..).setXXX(..)}.
*/
- public Builder setGroupOperatingFrequency(int frequency) {
+ public @NonNull Builder setGroupOperatingFrequency(int frequency) {
if (frequency < 0) {
throw new IllegalArgumentException(
"Invalid group operating frequency!");
@@ -391,7 +402,7 @@
* @return The builder to facilitate chaining
* {@code builder.setXXX(..).setXXX(..)}.
*/
- public Builder enablePersistentMode(boolean persistent) {
+ public @NonNull Builder enablePersistentMode(boolean persistent) {
if (persistent) {
mNetId = WifiP2pGroup.PERSISTENT_NET_ID;
} else {
@@ -404,7 +415,7 @@
* Build {@link WifiP2pConfig} given the current requests made on the builder.
* @return {@link WifiP2pConfig} constructed based on builder method calls.
*/
- public WifiP2pConfig build() {
+ public @NonNull WifiP2pConfig build() {
if (TextUtils.isEmpty(mNetworkName)) {
throw new IllegalStateException(
"network name must be non-empty.");
diff --git a/wifi/tests/src/android/net/wifi/p2p/WifiP2pConfigTest.java b/wifi/tests/src/android/net/wifi/p2p/WifiP2pConfigTest.java
index 560c88e..01a4c53 100644
--- a/wifi/tests/src/android/net/wifi/p2p/WifiP2pConfigTest.java
+++ b/wifi/tests/src/android/net/wifi/p2p/WifiP2pConfigTest.java
@@ -73,4 +73,44 @@
fail("expected IllegalArgumentException");
} catch (IllegalArgumentException e) { }
}
+
+ /**
+ * Check passphrase setter
+ */
+ @Test
+ public void testBuilderInvalidPassphrase() throws Exception {
+ WifiP2pConfig.Builder b = new WifiP2pConfig.Builder();
+
+ // sunny case
+ try {
+ b.setPassphrase("abcd1234");
+ } catch (IllegalArgumentException e) {
+ fail("Unexpected IllegalArgumentException");
+ }
+
+ // null string.
+ try {
+ b.setPassphrase(null);
+ fail("should throw IllegalArgumentException");
+ } catch (IllegalArgumentException e) {
+ // expected exception.
+ }
+
+ // less than 8 characters.
+ try {
+ b.setPassphrase("12abcde");
+ fail("should throw IllegalArgumentException");
+ } catch (IllegalArgumentException e) {
+ // expected exception.
+ }
+
+ // more than 63 characters.
+ try {
+ b.setPassphrase(
+ "abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ1234567890+/");
+ fail("should throw IllegalArgumentException");
+ } catch (IllegalArgumentException e) {
+ // expected exception.
+ }
+ }
}