ej.net.util.wifi

Class AccessPointConfiguration

java.lang.Object

ej.net.util.wifi.AccessPointConfiguration

public class AccessPointConfiguration
extends Object

A configuration to connect to an AccessPoint.

Constructor Summary

Constructors

Constructor and Description
AccessPointConfiguration(AccessPoint accessPoint) Instantiates an AccessPointConfiguration with an access point.
AccessPointConfiguration(String ssid) Instantiates an AccessPointConfiguration with a Service Set IDentification (SSID).
AccessPointConfiguration(String ssid, String passphrase, SecurityMode securityMode) Instantiates an AccessPointConfiguration.

Method Summary

Modifier and Type	Method and Description
AccessPoint	getAccessPoint() Gets the accessPoint.
String	getPassphrase() Gets the passphrase.
SecurityMode	getSecurityMode() Gets the security mode.
String	getSSID() Gets the Service Set IDentification (SSID).
void	setAccessPoint(AccessPoint accessPoint) Sets the accessPoint.
void	setPassphrase(String passphrase) Sets the passphrase.
void	setSecurityMode(SecurityMode securityMode) Sets the securityMode.
void	setSSID(String ssid) Sets the Service Set IDentification (SSID).

Methods inherited from class java.lang.Object

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

Constructor Detail

AccessPointConfiguration

public AccessPointConfiguration(@NonNull
                                AccessPoint accessPoint)
                         throws NullPointerException

Instantiates an AccessPointConfiguration with an access point.

Parameters:

accessPoint - the AccessPoint to use.

Throws:

NullPointerException - if accessPoint is null or its SSID.

AccessPointConfiguration

public AccessPointConfiguration(@NonNull
                                String ssid)
                         throws NullPointerException

Instantiates an AccessPointConfiguration with a Service Set IDentification (SSID).

Parameters:

ssid - the SSID to set.

Throws:

NullPointerException - when ssid is null.

AccessPointConfiguration

public AccessPointConfiguration(@NonNull
                                String ssid,
                                @Nullable
                                String passphrase,
                                @Nullable
                                SecurityMode securityMode)

Instantiates an AccessPointConfiguration.

Parameters:

ssid - the SSID to set.

passphrase - the passphrase to use.

securityMode - the securityMode to use.

Throws:

NullPointerException - when ssid is null.

Method Detail

getAccessPoint

public AccessPoint getAccessPoint()

Gets the accessPoint.

Returns:

the accessPoint.

getPassphrase

public String getPassphrase()

Gets the passphrase.

Returns:

the passphrase, can be null.

getSecurityMode

public SecurityMode getSecurityMode()

Gets the security mode. If an AccessPoint is set, set the AccessPoint Security Mode

Returns:

the security mode.

See Also:

AccessPoint.getSecurityMode()

getSSID

public String getSSID()

Gets the Service Set IDentification (SSID). If an AccessPoint is set, gets the AccessPoint SSID.

Returns:

the SSID.

See Also:

AccessPoint.getSSID()

setAccessPoint

public void setAccessPoint(@Nullable
                           AccessPoint accessPoint)

Sets the accessPoint.

Parameters:

accessPoint - the accessPoint to set.

setPassphrase

public void setPassphrase(@Nullable
                          String passphrase)

Sets the passphrase.

Parameters:

passphrase - the passphrase to set.

setSecurityMode

public void setSecurityMode(@Nullable
                            SecurityMode securityMode)

Sets the securityMode. If an AccessPoint is set, sets the AccessPoint securityMode.

Parameters:

securityMode - the securityMode to set.

setSSID

public void setSSID(@NonNull
                    String ssid)
             throws NullPointerException

Sets the Service Set IDentification (SSID). If an AccessPoint is set, sets the AccessPoint SSID.

Parameters:

ssid - the SSID to set.

Throws:

NullPointerException - if the SSID is null.