public class

WifiConfiguration

extends Object
implements Parcelable

java.lang.Object
↳	android.net.wifi.WifiConfiguration

Class Overview

A class representing a configured Wi-Fi network, including the security configuration. Android will not necessarily support all of these security schemes initially.

Summary

Nested Classes
public class	WifiConfiguration.AuthAlgorithm	Recognized IEEE 802.11 authentication algorithms.
public class	WifiConfiguration.GroupCipher	Recognized group ciphers.
public class	WifiConfiguration.KeyMgmt	Recognized key management schemes.
public class	WifiConfiguration.PairwiseCipher	Recognized pairwise ciphers for WPA.
public class	WifiConfiguration.Protocol	Recognized security protocols.
public class	WifiConfiguration.Status	Possible status of a network configuration.

[Expand]

Inherited Constants

From interface android.os.Parcelable

Fields
public String	BSSID	When set, this network configuration entry should only be used when associating with the AP having the specified BSSID.
public String	SSID	The network's SSID.
public BitSet	allowedAuthAlgorithms	The set of authentication protocols supported by this configuration.
public BitSet	allowedGroupCiphers	The set of group ciphers supported by this configuration.
public BitSet	allowedKeyManagement	The set of key management protocols supported by this configuration.
public BitSet	allowedPairwiseCiphers	The set of pairwise ciphers for WPA supported by this configuration.
public BitSet	allowedProtocols	The set of security protocols supported by this configuration.
public boolean	hiddenSSID	This is a network that does not broadcast its SSID, so an SSID-specific probe request must be used for scans.
public int	networkId	The ID number that the supplicant uses to identify this network configuration entry.
public String	preSharedKey	Pre-shared key for use with WPA-PSK.
public int	priority	Priority determines the preference given to a network by `wpa_supplicant` when choosing an access point with which to associate.
public int	status	The current status of this network configuration entry.
public String[]	wepKeys	Up to four WEP keys.
public int	wepTxKeyIndex	Default WEP key index, ranging from 0 to 3.

Public Constructors
	WifiConfiguration()

Public Methods
String	toString() Returns a string containing a concise, human-readable description of this object.

[Expand]

Inherited Methods

From class java.lang.Object

Object	clone() Creates and returns a copy of this `Object`.
boolean	equals(Object o) Compares this instance with the specified object and indicates if they are equal.
void	finalize() Is called before the object's memory is being reclaimed by the VM.
final Class<? extends Object>	getClass() Returns the unique instance of Class which represents this object's class.
int	hashCode() Returns an integer hash code for this object.
final void	notify() Causes a thread which is waiting on this object's monitor (by means of calling one of the `wait()` methods) to be woken up.
final void	notifyAll() Causes all threads which are waiting on this object's monitor (by means of calling one of the `wait()` methods) to be woken up.
String	toString() Returns a string containing a concise, human-readable description of this object.
final void	wait(long millis, int nanos) Causes the calling thread to wait until another thread calls the `notify()` or `notifyAll()` method of this object or until the specified timeout expires.
final void	wait(long millis) Causes the calling thread to wait until another thread calls the `notify()` or `notifyAll()` method of this object or until the specified timeout expires.
final void	wait() Causes the calling thread to wait until another thread calls the `notify()` or `notifyAll()` method of this object.

From interface android.os.Parcelable

Fields

public String BSSID

When set, this network configuration entry should only be used when associating with the AP having the specified BSSID. The value is a string in the format of an Ethernet MAC address, e.g., XX:XX:XX:XX:XX:XX where each X is a hex digit.

public String SSID

The network's SSID. Can either be an ASCII string, which must be enclosed in double quotation marks (e.g., "MyNetwork", or a string of hex digits,which are not enclosed in quotes (e.g., 01a243f405).

public BitSet allowedAuthAlgorithms

The set of authentication protocols supported by this configuration. See WifiConfiguration.AuthAlgorithm for descriptions of the values. Defaults to automatic selection.

public BitSet allowedGroupCiphers

The set of group ciphers supported by this configuration. See WifiConfiguration.GroupCipher for descriptions of the values. Defaults to CCMP TKIP WEP104 WEP40.

public BitSet allowedKeyManagement

The set of key management protocols supported by this configuration. See WifiConfiguration.KeyMgmt for descriptions of the values. Defaults to WPA-PSK WPA-EAP.

public BitSet allowedPairwiseCiphers

The set of pairwise ciphers for WPA supported by this configuration. See WifiConfiguration.PairwiseCipher for descriptions of the values. Defaults to CCMP TKIP.

public BitSet allowedProtocols

The set of security protocols supported by this configuration. See WifiConfiguration.Protocol for descriptions of the values. Defaults to WPA RSN.

public boolean hiddenSSID

This is a network that does not broadcast its SSID, so an SSID-specific probe request must be used for scans.

public int networkId

The ID number that the supplicant uses to identify this network configuration entry. This must be passed as an argument to most calls into the supplicant.

public String preSharedKey

Pre-shared key for use with WPA-PSK.

When the value of this key is read, the actual key is not returned, just a "*" if the key has a value, or the null string otherwise.

public int priority

Priority determines the preference given to a network by wpa_supplicant when choosing an access point with which to associate.

public int status

The current status of this network configuration entry.

public String[] wepKeys

Up to four WEP keys. Either an ASCII string enclosed in double quotation marks (e.g., "abcdef" or a string of hex digits (e.g., 0102030405).

When the value of one of these keys is read, the actual key is not returned, just a "*" if the key has a value, or the null string otherwise.

public int wepTxKeyIndex

Default WEP key index, ranging from 0 to 3.

Public Constructors

public WifiConfiguration ()

Public Methods

public String toString ()

Returns a string containing a concise, human-readable description of this object. Subclasses are encouraged to override this method and provide an implementation that takes into account the object's type and data. The default implementation simply concatenates the class name, the '@' sign and a hexadecimal representation of the object's hashCode(), that is, it is equivalent to the following expression:

 getClass().getName() + '@' + Integer.toHexString(hashCode())

Returns

a printable representation of this object.

Classes

Enums