Build 1.0_r1(from source)

android.net.wifi
Class WifiConfiguration

java.lang.Object
  extended by android.net.wifi.WifiConfiguration
All Implemented Interfaces:
Parcelable

public class WifiConfiguration
extends Object
implements Parcelable

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


Nested Class Summary
static class WifiConfiguration.AuthAlgorithm
          Recognized IEEE 802.11 authentication algorithms.
static class WifiConfiguration.GroupCipher
          Recognized group ciphers.
static class WifiConfiguration.KeyMgmt
          Recognized key management schemes.
static class WifiConfiguration.PairwiseCipher
          Recognized pairwise ciphers for WPA.
static class WifiConfiguration.Protocol
          Recognized security protocols.
static class WifiConfiguration.Status
          Possible status of a network configuration.
 
Nested classes/interfaces inherited from interface android.os.Parcelable
Parcelable.Creator<T>
 
Field Summary
 BitSet allowedAuthAlgorithms
          The set of authentication protocols supported by this configuration.
 BitSet allowedGroupCiphers
          The set of group ciphers supported by this configuration.
 BitSet allowedKeyManagement
          The set of key management protocols supported by this configuration.
 BitSet allowedPairwiseCiphers
          The set of pairwise ciphers for WPA supported by this configuration.
 BitSet allowedProtocols
          The set of security protocols supported by this configuration.
 String BSSID
          When set, this network configuration entry should only be used when associating with the AP having the specified BSSID.
static String bssidVarName
          
static Parcelable.Creator<WifiConfiguration> CREATOR
          Implement the Parcelable interface
 boolean hiddenSSID
          This is a network that does not broadcast its SSID, so an SSID-specific probe request must be used for scans.
static String hiddenSSIDVarName
          
 int networkId
          The ID number that the supplicant uses to identify this network configuration entry.
 String preSharedKey
          Pre-shared key for use with WPA-PSK.
 int priority
          Priority determines the preference given to a network by wpa_supplicant when choosing an access point with which to associate.
static String priorityVarName
          
static String pskVarName
          
 String SSID
          The network's SSID.
static String ssidVarName
          
 int status
          The current status of this network configuration entry.
 String[] wepKeys
          Up to four WEP keys.
static String[] wepKeyVarNames
          
static String wepTxKeyIdxVarName
          
 int wepTxKeyIndex
          Default WEP key index, ranging from 0 to 3.
 
Fields inherited from interface android.os.Parcelable
CONTENTS_FILE_DESCRIPTOR, PARCELABLE_WRITE_RETURN_VALUE
 
Constructor Summary
WifiConfiguration()
           
 
Method Summary
 int describeContents()
          Implement the Parcelable interface
 void writeToParcel(Parcel dest, int flags)
          Implement the Parcelable interface
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

ssidVarName

public static final String ssidVarName

See Also:
Constant Field Values

bssidVarName

public static final String bssidVarName

See Also:
Constant Field Values

pskVarName

public static final String pskVarName

See Also:
Constant Field Values

wepKeyVarNames

public static final String[] wepKeyVarNames


wepTxKeyIdxVarName

public static final String wepTxKeyIdxVarName

See Also:
Constant Field Values

priorityVarName

public static final String priorityVarName

See Also:
Constant Field Values

hiddenSSIDVarName

public static final String hiddenSSIDVarName

See Also:
Constant Field Values

networkId

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.


status

public int status
The current status of this network configuration entry.

See Also:
WifiConfiguration.Status

SSID

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


BSSID

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.


preSharedKey

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.


wepKeys

public String[] wepKeys
Up to four WEP keys. Either an ASCII string enclosed in double quotation marks (e.g., &quot;abcdef&quot; 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.


wepTxKeyIndex

public int wepTxKeyIndex
Default WEP key index, ranging from 0 to 3.


priority

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


hiddenSSID

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


allowedKeyManagement

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.


allowedProtocols

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


allowedAuthAlgorithms

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


allowedPairwiseCiphers

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.


allowedGroupCiphers

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.


CREATOR

public static final Parcelable.Creator<WifiConfiguration> CREATOR
Implement the Parcelable interface

Constructor Detail

WifiConfiguration

public WifiConfiguration()
Method Detail

describeContents

public int describeContents()
Implement the Parcelable interface

Specified by:
describeContents in interface Parcelable
Returns:
a bitmask indicating the set of special object types marshalled by the Parcelable.

writeToParcel

public void writeToParcel(Parcel dest,
                          int flags)
Implement the Parcelable interface

Specified by:
writeToParcel in interface Parcelable
Parameters:
dest - The Parcel in which the object should be written.
flags - Additional flags about how the object should be written. May be 0 or Parcelable.PARCELABLE_WRITE_RETURN_VALUE.

Build 1.0_r1(from source)

Please submit a feedback, bug or feature