net.rim.device.api.wlan.hotspot
Class HotspotInfo

java.lang.Object
  net.rim.device.api.wlan.hotspot.HotspotInfo

public final class HotspotInfo
extends Object

This class is used as a container for hotspot information passed from client to system.

For more information, please refer to the API overview section provided in HotspotClientRegistry.

Category:

Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.

Since:

BlackBerry API 5.0.0

Field Summary
	static int	AUTOMATIC_LOGIN_FLAG Flag that identifies the login type of the network.
	static int	FLAG_INVALID Flag is invalid.
	static int	FLAG_SET Flag is set.
	static int	FLAG_UNSET Flag is unset.
	static int	NETWORK_DELAY_FLAG Flag that specifies whether to delay login into automatic networks.
	static int	PROBE_NETWORK_FLAG Flag that identifies whether the network requires probing.
	static int	PROPERTY_BSSID A TLE tag used to identify the BSSID of the hotspot.
	static int	PROPERTY_CHANNEL A TLE tag used to identify the channel of the AP.
	static int	PROPERTY_HOTSPOT_PASSWORD A TLE tag used to identify the user's password for hotspot login.
	static int	PROPERTY_HOTSPOT_USERNAME A TLE tag used to identify the user's username for hotspot login.
	static int	PROPERTY_LOGIN_DELAY A TLE tag used to identify the delay time (in milliseconds) before the system tries to login to an automatic type hotspot.
	static int	PROPERTY_LOGIN_MESSAGE A TLE tag used to identify a message to be displayed to the user before they login.
	static int	PROPERTY_LOGOUT_MESSAGE A TLE tag used to identify a message to be displayed to the user before they logout.
	static int	PROPERTY_SECURITY_TYPE A TLE tag used to identify the security type of the network.
	static int	PROPERTY_SITE_NAME A TLE tag used to identify the site name of the hotspot.
	static int	PROPERTY_SSID A TLE tag used to identify the SSID of the hotspot.
	static int	SECURITY_TYPE_OPEN Open security type.

Constructor Summary
	HotspotInfo(WLANInfo.WLANAPInfo network, boolean automaticLoginType) Creates a HotspotInfo object from an WLANInfo.WLANAPInfo object.

Method Summary
	int	getFlag(int flag) Retrieves the value of the indicated flag.
	int	getIntProperty(int property) Retrieves an integer type hotspot property.
	String	getStringProperty(int property) Retrieves a String-type hotspot property.
	void	setFlag(int flag, boolean bool) Sets the state of provided flag.
	void	setProperty(int property, int value) Sets an integer type hotspot property.
	void	setProperty(int property, String value) Sets a String-type hotspot property.

Methods inherited from class java.lang.Object

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

Field Detail

PROPERTY_SSID

public static final int PROPERTY_SSID

A TLE tag used to identify the SSID of the hotspot. The SSID property is a read-only String type.

See Also:

Constant Field Values

Category:

Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.

Since:

BlackBerry API 5.0.0

PROPERTY_BSSID

public static final int PROPERTY_BSSID

A TLE tag used to identify the BSSID of the hotspot. The BSSID property is a read-only String type.

See Also:

Constant Field Values

Category:

Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.

Since:

BlackBerry API 5.0.0

PROPERTY_SITE_NAME

public static final int PROPERTY_SITE_NAME

A TLE tag used to identify the site name of the hotspot. The site name property's default value is the hotspot's SSID. The value object must be a String when setting and it cannot be null.

See Also:

Constant Field Values

Category:

Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.

Since:

BlackBerry API 5.0.0

PROPERTY_CHANNEL

public static final int PROPERTY_CHANNEL

A TLE tag used to identify the channel of the AP. The channel property is a read-only integer type.

See Also:

Constant Field Values

Category:

Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.

Since:

BlackBerry API 5.0.0

PROPERTY_SECURITY_TYPE

public static final int PROPERTY_SECURITY_TYPE

A TLE tag used to identify the security type of the network. The property is an integer type. The value must be one of the SECURITY_TYPE_ constants defined in this class. The default value is HotspotInfo.SECURITY_TYPE_OPEN.

See Also:

Constant Field Values

Category:

Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.

Since:

BlackBerry API 5.0.0

PROPERTY_HOTSPOT_USERNAME

public static final int PROPERTY_HOTSPOT_USERNAME

A TLE tag used to identify the user's username for hotspot login. The value object must be a String when setting.

See Also:

Constant Field Values

Category:

Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.

Since:

BlackBerry API 5.0.0

PROPERTY_HOTSPOT_PASSWORD

public static final int PROPERTY_HOTSPOT_PASSWORD

A TLE tag used to identify the user's password for hotspot login. The value object must be a String when setting.

See Also:

Constant Field Values

Category:

Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.

Since:

BlackBerry API 5.0.0

PROPERTY_LOGIN_DELAY

public static final int PROPERTY_LOGIN_DELAY

A TLE tag used to identify the delay time (in milliseconds) before the system tries to login to an automatic type hotspot. The property is an integer type. The default value of this property is 0. When setting, the value must be greater than or equal to 0.

See Also:

Constant Field Values

Category:

Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.

Since:

BlackBerry API 5.0.0

PROPERTY_LOGIN_MESSAGE

public static final int PROPERTY_LOGIN_MESSAGE

A TLE tag used to identify a message to be displayed to the user before they login. The value object must be a String when setting.

See Also:

Constant Field Values

Category:

Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.

Since:

BlackBerry API 5.0.0

PROPERTY_LOGOUT_MESSAGE

public static final int PROPERTY_LOGOUT_MESSAGE

A TLE tag used to identify a message to be displayed to the user before they logout. The value object must be a String when setting.

See Also:

Constant Field Values

Category:

Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.

Since:

BlackBerry API 5.0.0

AUTOMATIC_LOGIN_FLAG

public static final int AUTOMATIC_LOGIN_FLAG

Flag that identifies the login type of the network. Login type can be either automatic (flag set) or manual (flag unset).

See Also:

Constant Field Values

Category:

Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.

Since:

BlackBerry API 5.0.0

PROBE_NETWORK_FLAG

public static final int PROBE_NETWORK_FLAG

Flag that identifies whether the network requires probing.

This flag is not supported in the Hotspot API version 1.0.

Tip: Use HotspotClientRegistry.isFeatureSupported(byte) to check if network probing is supported.

See Also:

Constant Field Values

Category:

Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.

Since:

BlackBerry API 5.0.0

NETWORK_DELAY_FLAG

public static final int NETWORK_DELAY_FLAG

Flag that specifies whether to delay login into automatic networks.

Once this is set, the delay time can be specified using . By default, this flag will not be set (i.e. no network delay).

Tip: Use {#link HotspotClientRegistry#isFeatureSupported} to check if network delay feature is supported.

See Also:

Constant Field Values

Category:

Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.

Since:

BlackBerry API 6.0.0

SECURITY_TYPE_OPEN

public static final int SECURITY_TYPE_OPEN

Open security type. One of the values to which PROPERTY_SECURITY_TYPE may be set.

See Also:

Constant Field Values

Category:

Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.

Since:

BlackBerry API 5.0.0

FLAG_INVALID

public static final int FLAG_INVALID

Flag is invalid. Returned by HotspotInfo.getFlag(int).

See Also:

Constant Field Values

Category:

Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.

Since:

BlackBerry API 5.0.0

FLAG_UNSET

public static final int FLAG_UNSET

Flag is unset. Returned by HotspotInfo.getFlag(int).

See Also:

Constant Field Values

Category:

Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.

Since:

BlackBerry API 5.0.0

FLAG_SET

public static final int FLAG_SET

Flag is set. Returned by HotspotInfo.getFlag(int).

See Also:

Constant Field Values

Category:

Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.

Since:

BlackBerry API 5.0.0

Constructor Detail

HotspotInfo

public HotspotInfo(WLANInfo.WLANAPInfo network,
                   boolean automaticLoginType)

Creates a HotspotInfo object from an WLANInfo.WLANAPInfo object.

The SSID, BSSID, and channel are copied from the network parameter. All other properties are set to default values.

Parameters:

network - WLAN network parameter from which the SSID, BSSID, and channel are copied to initialize HotspotInfo.

automaticLoginType - true if automatic login type and false otherwise.

Category:

Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.

Since:

BlackBerry API 5.0.0

Method Detail

setProperty

public void setProperty(int property,
                        String value)
                 throws IllegalArgumentException

Sets a String-type hotspot property.

Property, constant that begins with PROPERTY_ in this class, must be a String type.

Parameters:

property - defines which String property to modify.

value - String value of the property.

Throws:

IllegalArgumentException - thrown when the property or value is invalid.

Category:

Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.

Since:

BlackBerry API 5.0.0

setProperty

public void setProperty(int property,
                        int value)
                 throws IllegalArgumentException

Sets an integer type hotspot property.

The property must be a PROPERTY_ constant that is an integer type.

Parameters:

property - Property to set. Must be one of the integer type PROPERTY_ constants defined in this class.

value - int value of the property.

Throws:

IllegalArgumentException - thrown when the property or value is invalid.

Category:

Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.

Since:

BlackBerry API 5.0.0

getStringProperty

public String getStringProperty(int property)
                         throws IllegalArgumentException

Retrieves a String-type hotspot property.

Property, constant that begins with PROPERTY_ in this class, must be a String type.

Parameters:

property - defines which String property to retrieve.

Throws:

IllegalArgumentException - thrown when the property is invalid.

Category:

Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.

Since:

BlackBerry API 5.0.0

getIntProperty

public int getIntProperty(int property)
                   throws IllegalArgumentException

Retrieves an integer type hotspot property.

The property must be a PROPERTY_ constant that is an integer type.

Parameters:

property - Property to retrieve. Must be one of the integer type PROPERTY_ constants defined in this class.

Throws:

IllegalArgumentException - thrown when the property is invalid.

Category:

Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.

Since:

BlackBerry API 5.0.0

setFlag

public void setFlag(int flag,
                    boolean bool)
             throws IllegalArgumentException

Sets the state of provided flag.

Parameters:

flag - flag to set. Must be one of the _FLAG constants defined in this class.

bool - true if the flag should be set, false if the flag should be cleared.

Throws:

IllegalArgumentException - thrown when the flag is invalid.

Category:

Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.

Since:

BlackBerry API 5.0.0

getFlag

public int getFlag(int flag)

Retrieves the value of the indicated flag.

Parameters:

flag - flag to check. Must be one of the _FLAG constants in this class.

Returns:

HotspotInfo.FLAG_SET if the flag is set, HotspotInfo.FLAG_UNSET if it is unset or HotspotInfo.FLAG_INVALID if the flag's state had never been set with HotspotInfo.setFlag(int, boolean).

Throws:

IllegalArgumentException - thrown when the flag is invalid.

Category:

Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.

Since:

BlackBerry API 5.0.0