org.eclipse.kura.net.wifi

Class WifiConfig

java.lang.Object

org.eclipse.kura.net.wifi.WifiConfig

All Implemented Interfaces:

NetConfig

@ProviderType
public class WifiConfig
extends java.lang.Object
implements NetConfig

Configuration for a wifi interface based on IPv4 addresses.

Constructor Summary

Constructors

Constructor and Description
WifiConfig()
WifiConfig(WifiMode mode, java.lang.String ssid, int[] channels, WifiSecurity security, java.lang.String passkey, java.lang.String hwMode, boolean broadcast, WifiBgscan bgscan) Deprecated. since 2.3. Use WifiConfig(WifiMode mode, String ssid, int[] channels, WifiSecurity security, String passkey, String hwMode, WifiBgscan bgscan)
WifiConfig(WifiMode mode, java.lang.String ssid, int[] channels, WifiSecurity security, java.lang.String passkey, java.lang.String hwMode, WifiBgscan bgscan)

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj)
WifiBgscan	getBgscan()
boolean	getBroadcast() Deprecated. since 2.3
java.util.List<WifiChannel>	getChannelFrequencies() Get the list of Wi-Fi channels and frequencies
int[]	getChannels()
java.lang.String	getDriver()
WifiCiphers	getGroupCiphers()
java.lang.String	getHardwareMode()
WifiMode	getMode()
WifiCiphers	getPairwiseCiphers()
Password	getPasskey()
WifiRadioMode	getRadioMode()
WifiSecurity	getSecurity()
java.lang.String	getSSID()
java.lang.String	getWifiCountryCode() Get the Wi-Fi country code
int	hashCode()
boolean	ignoreSSID()
boolean	isValid() Checks whether or not this configuration is valid.
boolean	pingAccessPoint()
void	setBgscan(WifiBgscan bgscan)
void	setBroadcast(boolean broadcast) Deprecated. since 2.3
void	setChannelFrequencies(java.util.List<WifiChannel> channelFrequencies) Set the list of channel frequencies
void	setChannels(int[] channels)
void	setDriver(java.lang.String driver)
void	setGroupCiphers(WifiCiphers group)
void	setHardwareMode(java.lang.String hwMode)
void	setIgnoreSSID(boolean ignoreSSID)
void	setMode(WifiMode mode)
void	setPairwiseCiphers(WifiCiphers pairwise)
void	setPasskey(java.lang.String key)
void	setPingAccessPoint(boolean pingAP)
void	setRadioMode(WifiRadioMode radioMode)
void	setSecurity(WifiSecurity security)
void	setSSID(java.lang.String ssid)
void	setWifiCountryCode(java.lang.String wifiCountryCode) Set the Wi-Fi country code
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

WifiConfig

public WifiConfig()

WifiConfig

@Deprecated
public WifiConfig(WifiMode mode,
                              java.lang.String ssid,
                              int[] channels,
                              WifiSecurity security,
                              java.lang.String passkey,
                              java.lang.String hwMode,
                              boolean broadcast,
                              WifiBgscan bgscan)

Deprecated. since 2.3. Use WifiConfig(WifiMode mode, String ssid, int[] channels, WifiSecurity security, String passkey, String hwMode, WifiBgscan bgscan)

WifiConfig

public WifiConfig(WifiMode mode,
                  java.lang.String ssid,
                  int[] channels,
                  WifiSecurity security,
                  java.lang.String passkey,
                  java.lang.String hwMode,
                  WifiBgscan bgscan)

Parameters:

mode - for the configuration as WifiMode

ssid - of the the wifi interface

channels - supported by the wifi interface

security - mode of the interface as WifiSecurity

passkey - for the wifi interface

hwMode - the hardware mode

bgscan - the background scan

Since:

2.3

Method Detail

getMode

public WifiMode getMode()

setMode

public void setMode(WifiMode mode)

getSSID

public java.lang.String getSSID()

setSSID

public void setSSID(java.lang.String ssid)

getDriver

public java.lang.String getDriver()

setDriver

public void setDriver(java.lang.String driver)

getChannels

public int[] getChannels()

setChannels

public void setChannels(int[] channels)

getSecurity

public WifiSecurity getSecurity()

setSecurity

public void setSecurity(WifiSecurity security)

getPairwiseCiphers

public WifiCiphers getPairwiseCiphers()

setPairwiseCiphers

public void setPairwiseCiphers(WifiCiphers pairwise)

getGroupCiphers

public WifiCiphers getGroupCiphers()

setGroupCiphers

public void setGroupCiphers(WifiCiphers group)

getPasskey

public Password getPasskey()

setPasskey

public void setPasskey(java.lang.String key)

getHardwareMode

public java.lang.String getHardwareMode()

setHardwareMode

public void setHardwareMode(java.lang.String hwMode)

getRadioMode

public WifiRadioMode getRadioMode()

setRadioMode

public void setRadioMode(WifiRadioMode radioMode)

getBroadcast

@Deprecated
public boolean getBroadcast()

Deprecated. since 2.3

setBroadcast

@Deprecated
public void setBroadcast(boolean broadcast)

Deprecated. since 2.3

getBgscan

public WifiBgscan getBgscan()

setBgscan

public void setBgscan(WifiBgscan bgscan)

pingAccessPoint

public boolean pingAccessPoint()

setPingAccessPoint

public void setPingAccessPoint(boolean pingAP)

ignoreSSID

public boolean ignoreSSID()

setIgnoreSSID

public void setIgnoreSSID(boolean ignoreSSID)

getWifiCountryCode

public java.lang.String getWifiCountryCode()

Get the Wi-Fi country code

Returns:

Wi-Fi country code in ISO 3166-1 alpha-2

Since:

2.2

setWifiCountryCode

public void setWifiCountryCode(java.lang.String wifiCountryCode)

Set the Wi-Fi country code

Parameters:

wifiCountryCode - Wi-Fi Country code in ISO 3166-1 alpha-2 format

Since:

2.2

getChannelFrequencies

public java.util.List<WifiChannel> getChannelFrequencies()

Get the list of Wi-Fi channels and frequencies

Returns:

List of Wi-Fi channels and frequencies

Since:

2.2

setChannelFrequencies

public void setChannelFrequencies(java.util.List<WifiChannel> channelFrequencies)

Set the list of channel frequencies

Parameters:

channelFrequencies - list of Wi-Fi channels and relative frequencies

Since:

2.2

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

isValid

public boolean isValid()

Description copied from interface: NetConfig

Checks whether or not this configuration is valid.

Specified by:

isValid in interface NetConfig

Returns:

true if the configuration is valid, otherwise false

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object