ej.net.util.wifi

Class AccessPointConfiguration

java.lang.Object

ej.net.util.wifi.AccessPointConfiguration

public class AccessPointConfiguration
extends java.lang.Object

A configuration to connect to an AccessPoint.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
ej.ecom.wifi.AccessPoint	getAccessPoint() Gets the accessPoint.
java.lang.String	getPassphrase() Gets the passphrase.
ej.ecom.wifi.SecurityMode	getSecurityMode() Gets the security mode.
java.lang.String	getSSID() Gets the Service Set IDentification (SSID).
void	setAccessPoint(ej.ecom.wifi.AccessPoint accessPoint) Sets the accessPoint.
void	setPassphrase(java.lang.String passphrase) Sets the passphrase.
void	setSecurityMode(ej.ecom.wifi.SecurityMode securityMode) Sets the securityMode.
void	setSSID(java.lang.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
                                java.lang.String ssid)
                         throws java.lang.NullPointerException

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

Parameters:

ssid - the SSID to set.

Throws:

java.lang.NullPointerException - when ssid is null.

AccessPointConfiguration

public AccessPointConfiguration(@NonNull
                                ej.ecom.wifi.AccessPoint accessPoint)
                         throws java.lang.NullPointerException

Instantiates an AccessPointConfiguration with an access point.

Parameters:

accessPoint - the AccessPoint to use.

Throws:

java.lang.NullPointerException - if accessPoint is null or its SSID.

AccessPointConfiguration

public AccessPointConfiguration(@NonNull
                                java.lang.String ssid,
                                @Nullable
                                java.lang.String passphrase,
                                @Nullable
                                ej.ecom.wifi.SecurityMode securityMode)

Instantiates an AccessPointConfiguration.

Parameters:

ssid - the SSID to set.

passphrase - the passphrase to use.

securityMode - the securityMode to use.

Throws:

java.lang.NullPointerException - when ssid is null.

Method Detail

getPassphrase

public java.lang.String getPassphrase()

Gets the passphrase.

Returns:

the passphrase, can be null.

setPassphrase

public void setPassphrase(@Nullable
                          java.lang.String passphrase)

Sets the passphrase.

Parameters:

passphrase - the passphrase to set.

getSSID

public java.lang.String getSSID()

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

Returns:

the SSID.

See Also:

AccessPoint.getSSID()

setSSID

public void setSSID(@NonNull
                    java.lang.String ssid)
             throws java.lang.NullPointerException

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

Parameters:

ssid - the SSID to set.

Throws:

java.lang.NullPointerException - if the SSID is null.

getSecurityMode

public ej.ecom.wifi.SecurityMode getSecurityMode()

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

Returns:

the security mode.

See Also:

AccessPoint.getSecurityMode()

setSecurityMode

public void setSecurityMode(@Nullable
                            ej.ecom.wifi.SecurityMode securityMode)

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

Parameters:

securityMode - the securityMode to set.

getAccessPoint

public ej.ecom.wifi.AccessPoint getAccessPoint()

Gets the accessPoint.

Returns:

the accessPoint.

setAccessPoint

public void setAccessPoint(@Nullable
                           ej.ecom.wifi.AccessPoint accessPoint)

Sets the accessPoint.

Parameters:

accessPoint - the accessPoint to set.