WifiNetworkSpecifier.Builder

Builder

public Builder ()

build

public WifiNetworkSpecifier build ()

Create a specifier object used to request a Wi-Fi network. The generated NetworkSpecifier should be used in NetworkRequest.Builder#setNetworkSpecifier(NetworkSpecifier) when building the NetworkRequest.

When using with ConnectivityManager#requestNetwork(NetworkRequest, NetworkCallback) or variants, note that some devices may not support requesting a network with all combinations of specifier members. For example, some devices may only support requesting local-only networks (networks without the NetworkCapabilities#NET_CAPABILITY_INTERNET capability), or not support requesting a particular band. However, there are no restrictions when using ConnectivityManager#registerNetworkCallback(NetworkRequest, NetworkCallback) or other similar methods which monitor but do not request networks. If the device can't support a request, the app will receive a call to NetworkCallback#onUnavailable().

When requesting a local-only network, apps can set a combination of network match params:

final NetworkSpecifier specifier =
      new Builder()
      .setSsidPattern(new PatternMatcher("test", PatternMatcher.PATTERN_PREFIX))
      .setBssidPattern(MacAddress.fromString("10:03:23:00:00:00"),
                       MacAddress.fromString("ff:ff:ff:00:00:00"))
      .build()
 final NetworkRequest request =
      new NetworkRequest.Builder()
      .addTransportType(NetworkCapabilities.TRANSPORT_WIFI)
      .removeCapability(NetworkCapabilities.NET_CAPABILITY_INTERNET)
      .setNetworkSpecifier(specifier)
      .build();
 final ConnectivityManager connectivityManager =
      context.getSystemService(Context.CONNECTIVITY_SERVICE);
 final NetworkCallback networkCallback = new NetworkCallback() {
      ...
      {@literal @}Override
      void onAvailable(...) {}
      // etc.
 };
 connectivityManager.requestNetwork(request, networkCallback);
 

setBand

public WifiNetworkSpecifier.Builder setBand (int band)

Specifies the band requested for this network. Only a single band can be requested. An app can file multiple callbacks concurrently if they need to know about multiple bands.

setBssid

public WifiNetworkSpecifier.Builder setBssid (MacAddress bssid)

Set the BSSID to use for filtering networks from scan results. Will only match network whose BSSID is identical to the specified value.

setBssidPattern

public WifiNetworkSpecifier.Builder setBssidPattern (MacAddress baseAddress, 
                MacAddress mask)

Set the BSSID match pattern to use for filtering networks from scan results. Will match all networks with BSSID which satisfies the following: BSSID & mask == baseAddress.

setIsEnhancedOpen

public WifiNetworkSpecifier.Builder setIsEnhancedOpen (boolean isEnhancedOpen)

Specifies whether this represents an Enhanced Open (OWE) network.

setIsHiddenSsid

public WifiNetworkSpecifier.Builder setIsHiddenSsid (boolean isHiddenSsid)

Specifies whether this represents a hidden network.

setPreferredChannelsFrequenciesMhz

public WifiNetworkSpecifier.Builder setPreferredChannelsFrequenciesMhz (int[] channelFreqs)

Specifies the preferred channels for this network. The channels set in the request will be used to optimize the scan and connection.

setSsid

public WifiNetworkSpecifier.Builder setSsid (String ssid)

Set the unicode SSID for the network.

setSsidPattern

public WifiNetworkSpecifier.Builder setSsidPattern (PatternMatcher ssidPattern)

Set the unicode SSID match pattern to use for filtering networks from scan results.

setWpa2EnterpriseConfig

public WifiNetworkSpecifier.Builder setWpa2EnterpriseConfig (WifiEnterpriseConfig enterpriseConfig)

Set the associated enterprise configuration for this network. Needed for authenticating to WPA2-EAP networks. See WifiEnterpriseConfig for description. Local-only connection will not support Trust On First Use (TOFU). If TOFU is enabled on this Enterprise Config, framework will reject the connection. See WifiEnterpriseConfig.enableTrustOnFirstUse(boolean)

setWpa2Passphrase

public WifiNetworkSpecifier.Builder setWpa2Passphrase (String passphrase)

Set the ASCII WPA2 passphrase for this network. Needed for authenticating to WPA2-PSK networks.

setWpa3Enterprise192BitModeConfig

public WifiNetworkSpecifier.Builder setWpa3Enterprise192BitModeConfig (WifiEnterpriseConfig enterpriseConfig)

Set the associated enterprise configuration for this network. Needed for authenticating to WPA3-Enterprise in 192-bit security mode networks. See WifiEnterpriseConfig for description. Both the client and CA certificates must be provided, and must be of type of either sha384WithRSAEncryption with key length of 3072bit or more (OID 1.2.840.113549.1.1.12), or ecdsa-with-SHA384 with key length of 384bit or more (OID 1.2.840.10045.4.3.3). Local-only connection will not support Trust On First Use (TOFU). If TOFU is enabled on this Enterprise Config, framework will reject the connection. See WifiEnterpriseConfig#enableTrustOnFirstUse

setWpa3EnterpriseConfig

public WifiNetworkSpecifier.Builder setWpa3EnterpriseConfig (WifiEnterpriseConfig enterpriseConfig)

This method was deprecated in API level 31.
use setWpa3EnterpriseStandardModeConfig(android.net.wifi.WifiEnterpriseConfig) or setWpa3Enterprise192BitModeConfig(android.net.wifi.WifiEnterpriseConfig) to specify WPA3-Enterprise type explicitly.

Set the associated enterprise configuration for this network. Needed for authenticating to WPA3-Enterprise networks (standard and 192-bit security). See WifiEnterpriseConfig for description. For 192-bit security networks, both the client and CA certificates must be provided, and must be of type of either sha384WithRSAEncryption (OID 1.2.840.113549.1.1.12) or ecdsa-with-SHA384 (OID 1.2.840.10045.4.3.3).

setWpa3EnterpriseStandardModeConfig

public WifiNetworkSpecifier.Builder setWpa3EnterpriseStandardModeConfig (WifiEnterpriseConfig enterpriseConfig)

Set the associated enterprise configuration for this network. Needed for authenticating to standard WPA3-Enterprise networks. See WifiEnterpriseConfig for description. For WPA3-Enterprise in 192-bit security mode networks, see setWpa3Enterprise192BitModeConfig(android.net.wifi.WifiEnterpriseConfig) for description. Local-only connection will not support Trust On First Use (TOFU). If TOFU is enabled on this Enterprise Config, framework will reject the connection. See WifiEnterpriseConfig.enableTrustOnFirstUse(boolean)

setWpa3Passphrase

public WifiNetworkSpecifier.Builder setWpa3Passphrase (String passphrase)

Set the ASCII WPA3 passphrase for this network. Needed for authenticating to WPA3-SAE networks.