Package ej.net.util.wifi

Class WifiNetworkManager

java.lang.Object

ej.net.util.wifi.WifiNetworkManager

public class WifiNetworkManager
extends Object

This manager manage the Wi-Fi manager and network to keep a state.

See Also:

WifiManager, NetworkInterfaceManager

Constructor Summary

Constructors

Constructor	Description
WifiNetworkManager()	Instantiates a WifiNetworkManager with a default AccessPointConfiguration and SoftAPConfiguration.
WifiNetworkManager(AccessPointConfiguration configurationAP, SoftAPConfiguration softAPConfiguration)	Instantiates a WifiNetworkManager.

Method Summary

Modifier and Type	Method	Description
AccessPointConfiguration	getAPConfiguration()	Gets the configurationAP.
WifiCapability	getCapabilities()	Gets the WifiCapability.
String	getInterfaceName()	Gets the interfaceName.
AccessPoint	getJoinedAccessPoint()	Gets the joined access.
SoftAPConfiguration	getSoftAPConfiguration()	Gets the softAPConfiguration.
NetworkInterface	getWifiInterface()	Gets the wifi Interface.
WifiManager	getWifiManager()	Gets the Wi-FI manager used.
boolean	isConnected()	Checks if the Wi-FI is connected to network.
boolean	isInit()	Checks if the Wi-FI Manager is initialized.
boolean	isSoftAPEnabled()	Checks if the Wi-FI is has enabled the softAP.
void	joinAccessPoint(int timeout)	Joins the access point configuration selected.
void	joinAccessPoint(AccessPoint access, String password, int timeout)	Joins a specific AccessPoint.
void	joinAccessPoint(String ssid, String password, SecurityMode securityMode, int timeout)	Joins a particular Access Point.
void	leaveAccessPoint()	Leaves the joined Access Point.
void	mountSoftAccessPoint()	Mounts a Soft Access Point.
void	mountSoftAccessPoint(SoftAPConfiguration config)	Mounts a Soft Access Point.
AccessPoint[]	scanAccessPoints()	Scans Access Points.
void	setAPConfiguration(AccessPointConfiguration configurationAP)	Sets the configurationAP.
void	setClientIPConfigure(IPConfiguration ipConfiguration)	Sets the IPConfiguration for the interface while in client mode.
void	setInterfaceName(String interfaceName)	Sets the interfaceName.
void	setScanWhileSoftAP(boolean scanWhileSoftAP)	Sets whether it supports scan while mounted.
void	setSoftAPConfiguration(SoftAPConfiguration softAPConfiguration)	Sets the softAPConfiguration.
void	setSoftAPIPConfigure(IPConfiguration softAPIPConfiguration)	Sets the IPConfiguration for the interface while in softAP.
boolean	supportScanWhileSoftAP()	Gets whether it supports scan while in softAP.
void	unmountSoftAccessPoint()	Unmounts a Soft Access Point.

Methods inherited from class java.lang.Object

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

Constructor Detail

WifiNetworkManager

public WifiNetworkManager()
                   throws IOException

Instantiates a WifiNetworkManager with a default AccessPointConfiguration and SoftAPConfiguration.

Throws:

IOException - When initialise fail.

See Also:

WifiNetworkManager(AccessPointConfiguration, SoftAPConfiguration)

WifiNetworkManager

public WifiNetworkManager(@NonNull
                          AccessPointConfiguration configurationAP,
                          @NonNull
                          SoftAPConfiguration softAPConfiguration)
                   throws IOException,
                          NullPointerException

Instantiates a WifiNetworkManager.

Parameters:

configurationAP - the configurationAP to use.

softAPConfiguration - the softAPConfiguration to use.

Throws:

IOException - When initialise fail.

NullPointerException - if parameters are null or WifiManager not found.

See Also:

WifiManager.getInstance()

Method Detail

isInit

public boolean isInit()

Checks if the Wi-FI Manager is initialized.

Returns:

true if the Wi-FI manager is initialized.

See Also:

NetworkInterfaceManager.isEnabled(NetworkInterface)

scanAccessPoints

public AccessPoint[] scanAccessPoints()
                               throws IOException

Scans Access Points.

Returns:

the list of available access points (it is empty if there is no available access point).

Throws:

IOException - if an error occurred.

See Also:

WifiManager.scan()

joinAccessPoint

public void joinAccessPoint(int timeout)
                     throws IOException,
                            NullPointerException,
                            UnsupportedOperationException,
                            IllegalArgumentException

Joins the access point configuration selected.

Parameters:

timeout - the timeout to wait for an IP, 0 for unlimited, cannot be less than 0.

Throws:

IOException - if an error occurred.

NullPointerException - if AP is not set.

UnsupportedOperationException - If the Wi-Fi does not support client mode.

IllegalArgumentException - if timeout is less than 0.

See Also:

getAPConfiguration(), AccessPointConfiguration.setAccessPoint(AccessPoint), joinAccessPoint(AccessPoint, String, int), joinAccessPoint(AccessPoint, String, int), joinAccessPoint(String, String, SecurityMode, int)

joinAccessPoint

public void joinAccessPoint(@NonNull
                            AccessPoint access,
                            @Nullable
                            String password,
                            int timeout)
                     throws IOException,
                            NullPointerException,
                            UnsupportedOperationException,
                            IllegalArgumentException

Joins a specific AccessPoint.

Parameters:

access - the AccessPoint to join.

password - the AccessPoint password.

timeout - the timeout to wait for an IP, 0 for unlimited, cannot be less than 0.

Throws:

IOException - if an error occurred.

NullPointerException - if the AP is null.

UnsupportedOperationException - If the Wi-Fi does not support client mode.

IllegalArgumentException - if timeout is less than 0.

See Also:

WifiManager.join(AccessPoint, String)

joinAccessPoint

public void joinAccessPoint(@NonNull
                            String ssid,
                            @Nullable
                            String password,
                            @Nullable
                            SecurityMode securityMode,
                            int timeout)
                     throws IOException,
                            UnsupportedOperationException,
                            IllegalArgumentException

Joins a particular Access Point.

Parameters:

ssid - the AP SSID.

password - the AP password.

securityMode - the security Mode to use.

timeout - the timeout to wait for an IP, 0 for unlimited, cannot be less than 0.

Throws:

IOException - if an error occurred.

UnsupportedOperationException - If the Wi-Fi does not support client mode.

IllegalArgumentException - if timeout is less than 0.

See Also:

WifiManager.join(String, String)

leaveAccessPoint

public void leaveAccessPoint()
                      throws IOException

Leaves the joined Access Point.

Throws:

IOException - if an error occurred.

See Also:

WifiManager.leave()

isConnected

public boolean isConnected()
                    throws IOException

Checks if the Wi-FI is connected to network.

Returns:

true if the Wi-FI manager is connected to a network.

Throws:

IOException - If an I/O error occurs.

See Also:

WifiManager.getJoined()

isSoftAPEnabled

public boolean isSoftAPEnabled()
                        throws IOException

Checks if the Wi-FI is has enabled the softAP.

Returns:

true if enabled, false otherwise.

Throws:

IOException - If an I/O error occurs.

See Also:

WifiManager.isSoftAPEnabled()

getJoinedAccessPoint

public AccessPoint getJoinedAccessPoint()
                                 throws IOException

Gets the joined access.

Returns:

the joined access, null if none.

Throws:

IOException - If an I/O error occurs.

See Also:

WifiManager.getJoined()

getAPConfiguration

public AccessPointConfiguration getAPConfiguration()

Gets the configurationAP.

Returns:

the configurationAP.

setAPConfiguration

public void setAPConfiguration(@NonNull
                               AccessPointConfiguration configurationAP)

Sets the configurationAP.

Parameters:

configurationAP - the configurationAP to set.

getSoftAPConfiguration

public SoftAPConfiguration getSoftAPConfiguration()

Gets the softAPConfiguration.

Returns:

the softAPConfiguration.

setSoftAPConfiguration

public void setSoftAPConfiguration(@NonNull
                                   SoftAPConfiguration softAPConfiguration)
                            throws NullPointerException

Sets the softAPConfiguration.

Parameters:

softAPConfiguration - the softAPConfiguration to set, cannot be null.

Throws:

NullPointerException - if SoftAPConfiguration is null.

mountSoftAccessPoint

public void mountSoftAccessPoint()
                          throws IOException

Mounts a Soft Access Point.

Throws:

IOException - if an error occurred.

See Also:

WifiManager.enableSoftAP(SoftAPConfiguration)

mountSoftAccessPoint

public void mountSoftAccessPoint(@NonNull
                                 SoftAPConfiguration config)
                          throws IOException,
                                 UnsupportedOperationException

Mounts a Soft Access Point.

Parameters:

config - the configuration to use.

Throws:

IOException - if an error occurred.

UnsupportedOperationException - If the Wi-Fi does not support SoftAP mode.

See Also:

WifiManager.enableSoftAP(SoftAPConfiguration)

unmountSoftAccessPoint

public void unmountSoftAccessPoint()
                            throws IOException

Unmounts a Soft Access Point.

Throws:

IOException - if an error occurred.

See Also:

WifiManager.disableSoftAP()

supportScanWhileSoftAP

public boolean supportScanWhileSoftAP()

Gets whether it supports scan while in softAP.

Returns:

true if scan while mounted is supported.

setScanWhileSoftAP

public void setScanWhileSoftAP(boolean scanWhileSoftAP)

Sets whether it supports scan while mounted.

Parameters:

scanWhileSoftAP - true if scan while mounted is supported.

getCapabilities

public WifiCapability getCapabilities()
                               throws IOException

Gets the WifiCapability.

Returns:

the capabilities.

Throws:

IOException - If an I/O error occurs.

See Also:

WifiManager.getCapability()

setClientIPConfigure

public void setClientIPConfigure(@Nullable
                                 IPConfiguration ipConfiguration)

Sets the IPConfiguration for the interface while in client mode. This will be taken in account on the next join.

Parameters:

ipConfiguration - the IPConfiguration to use, can be null then it won't be used.

setSoftAPIPConfigure

public void setSoftAPIPConfigure(@Nullable
                                 IPConfiguration softAPIPConfiguration)

Sets the IPConfiguration for the interface while in softAP. This will be taken in account on the next mountSoftAccessPoint().

Parameters:

softAPIPConfiguration - the IPConfiguration to use when in softAP.

getInterfaceName

public String getInterfaceName()

Gets the interfaceName.

Returns:

the interfaceName.

setInterfaceName

public void setInterfaceName(@Nullable
                             String interfaceName)

Sets the interfaceName.

Parameters:

interfaceName - the interfaceName to set.

getWifiManager

public WifiManager getWifiManager()

Gets the Wi-FI manager used.

Returns:

the Wi-FI manager.

getWifiInterface

public NetworkInterface getWifiInterface()

Gets the wifi Interface.

Returns:

the wifiInterface.