ej.ecom.wifi

Class WifiManager

java.lang.Object

ej.ecom.wifi.WifiManager

public class WifiManager
extends java.lang.Object

Manages the Wi-Fi capabilities.

Constructor Summary

Constructors

Constructor and Description
WifiManager()

Method Summary

Modifier and Type	Method and Description
void	disableSoftAP() Disables the Software enabled Access Point (SoftAP).
void	enableSoftAP(SoftAPConfiguration configuration) Enables the SoftAP with a given configuration.
WifiCapability	getCapability() Gets the Wi-Fi capability of the platform.
static WifiManager	getInstance() Returns the WifiManager instance.
AccessPoint	getJoined() Gets the currently joined Wi-Fi access point.
boolean	isSoftAPEnabled() Tells whether if SoftAP is currently enabled.
void	join(AccessPoint accessPoint, java.lang.String passphrase) Deprecated. Use join(AccessPoint, String, SecurityMode) instead. If you don't know the security mode used, use SecurityMode.UNKNOWN.
void	join(AccessPoint accessPoint, java.lang.String passphrase, SecurityMode securityMode) Joins a Wi-Fi network using a Wi-Fi access point, a passphrase and a security mode.
void	join(java.lang.String SSID, java.lang.String passphrase) Joins a Wi-Fi network using a SSID and a passphrase.
void	join(java.lang.String SSID, java.lang.String passphrase, SecurityMode securityMode) Joins a wireless network using an SSID and a passphrase.
void	leave() Leaves the currently joined Wi-Fi access point.
AccessPoint[]	scan() Performs an active scan of available Wi-Fi access points.
AccessPoint[]	scan(boolean active) Performs a scan of available access points.

Methods inherited from class java.lang.Object

clone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

WifiManager

public WifiManager()

Method Detail

getInstance

public static WifiManager getInstance()

Returns the WifiManager instance.

Returns:

WifiManager instance.

disableSoftAP

public void disableSoftAP()
                   throws java.io.IOException

Disables the Software enabled Access Point (SoftAP). This method has no effect if the SoftAP is not started.

Throws:

java.io.IOException - if an I/O error occurs

enableSoftAP

public void enableSoftAP(SoftAPConfiguration configuration)
                  throws java.io.IOException

Enables the SoftAP with a given configuration.

Parameters:

configuration - SoftAP configuration.

Throws:

java.io.IOException - if SoftAP mode is not supported, an access point is currently joined and the platform does support simultaneous mode (leave() must be called before this method) or an I/O error occurs.

getCapability

public WifiCapability getCapability()
                             throws java.io.IOException

Gets the Wi-Fi capability of the platform.

Returns:

Wi-Fi capability.

Throws:

java.io.IOException - If an I/O error occurs.

getJoined

@Nullable
public AccessPoint getJoined()
                                 throws java.io.IOException

Gets the currently joined Wi-Fi access point.

Returns:

currently joined Wi-Fi access point or null if no Wi-Fi access point has been joined yet.

Throws:

java.io.IOException - If an I/O error occurs.

isSoftAPEnabled

public boolean isSoftAPEnabled()
                        throws java.io.IOException

Tells whether if SoftAP is currently enabled.

Returns:

true if enabled, false otherwise.

Throws:

java.io.IOException - If an I/O error occurs.

join

@Deprecated
public void join(AccessPoint accessPoint,
                              java.lang.String passphrase)
                       throws java.io.IOException

Deprecated. Use join(AccessPoint, String, SecurityMode) instead. If you don't know the security mode used, use SecurityMode.UNKNOWN.

Joins a Wi-Fi network using a Wi-Fi access point, a passphrase and WPA2 as the security mode.

Parameters:

accessPoint - Wi-Fi access point.

passphrase - Wi-Fi access point passphrase. The passphrase must be a sequence of between 8 and 64 ASCII-encoded characters.

Throws:

java.io.IOException - if client mode is not supported, the SoftAP is currently enabled and the platform does support simultaneous mode ( disableSoftAP() must be called before this method), or an I/O error occurs.

java.lang.IllegalArgumentException - if the accessPoint or the passphrase is null.

join

public void join(AccessPoint accessPoint,
                 java.lang.String passphrase,
                 SecurityMode securityMode)
          throws java.io.IOException

Joins a Wi-Fi network using a Wi-Fi access point, a passphrase and a security mode.

Parameters:

accessPoint - Wi-Fi access point.

passphrase - Wi-Fi access point passphrase. The passphrase must be a sequence of between 8 and 64 ASCII-encoded characters.

securityMode - Wi-Fi access point security mode.

Throws:

java.io.IOException - if client mode is not supported, the SoftAP is currently enabled and the platform does support simultaneous mode ( disableSoftAP() must be called before this method), or an I/O error occurs.

java.lang.IllegalArgumentException - if the accessPoint or the passphrase is null.

join

public void join(java.lang.String SSID,
                 java.lang.String passphrase)
          throws java.io.IOException

Joins a Wi-Fi network using a SSID and a passphrase.

Parameters:

SSID - Wi-Fi access point Service Set Identifier (SSID).

passphrase - Wi-Fi access point passphrase. The passphrase must be a sequence of between 8 and 64 ASCII-encoded characters.

Throws:

java.io.IOException - if client mode is not supported, the SoftAP is currently enabled and the platform does support simultaneous mode ( disableSoftAP() must be called before this method), or an I/O error occurs.

java.lang.IllegalArgumentException - if the SSID or the passphrase is null.

join

public void join(java.lang.String SSID,
                 java.lang.String passphrase,
                 SecurityMode securityMode)
          throws java.io.IOException

Joins a wireless network using an SSID and a passphrase.

Parameters:

SSID - Wi-Fi access point Service Set Identifier (SSID).

passphrase - Wi-Fi access point passphrase. The passphrase must be a sequence of between 8 and 64 ASCII-encoded characters.

securityMode - Wi-Fi access point security mode.

Throws:

java.io.IOException - if client mode is not supported, the SoftAP is currently enabled and the platform does support simultaneous mode ( disableSoftAP() must be called before this method), or an I/O error occurs.

java.lang.IllegalArgumentException - if the SSID or the passphrase is null.

leave

public void leave()
           throws java.io.IOException

Leaves the currently joined Wi-Fi access point. If no Wi-Fi access point has been joined yet, this method has no effect.

Throws:

java.io.IOException - If an I/O error occurs.

scan

public AccessPoint[] scan()
                   throws java.io.IOException

Performs an active scan of available Wi-Fi access points. This is equivalent to scan(true).

Returns:

the list of available Wi-Fi access points or an empty list if there is no available Wi-Fi access point.

Throws:

java.io.IOException - if the underlying Wi-Fi network interface is currently stopped, scanning is not possible at the moment, or an I/O error occurs.

scan

public AccessPoint[] scan(boolean active)
                   throws java.io.IOException

Performs a scan of available access points.

Parameters:

active - true for an active scan, false for a passive scan.

Returns:

the list of available access points or an empty list if there is no available Wi-Fi access point.

Throws:

java.io.IOException - if the underlying network interface is currently stopped, scanning is not possible at the moment, or an I/O error occurs.