com.cinterion.io

Class BearerControl

java.lang.Object

com.cinterion.io.BearerControl

All Implemented Interfaces:

BearerControlStates

public class BearerControl
extends Object
implements BearerControlStates

The BearerControl class provides the ability to get bearer state events and to hang-up the bearer. This complements the IP networking functionality as provided by IMP-NG classes. The bearer is always opened implicitely during a call of connector.open with the provided parameters. Closure of bearer is either triggered by the networking idle time out after having closed the last socket on this bearer, or the hangUp methods of this class.

See Also:

SocketConnection, BearerControlListener

Field Summary

Fields inherited from interface com.cinterion.io.BearerControlStates

BEARER_STATE_CLOSING, BEARER_STATE_CONNECTING, BEARER_STATE_DOWN, BEARER_STATE_LIMITED_UP, BEARER_STATE_UNKNOWN, BEARER_STATE_UP

Method Summary

Methods

Modifier and Type	Method and Description
static void	addListener(BearerControlListener listener) Registers listeners to receive bearer state changes.
static void	addListenerEx(BearerControlListenerEx listener) Registers listeners to receive bearer state changes.
static void	clearListener() Removes all listener objects which have been previously added to the list table of listener objects.
static String[]	GetBearerList() Retrieve a string list with all current defined bearers in the system.
static int	GetBearerState(String APN) Retrieve the current state of the bearer.
static String	GetBearerV4Addr(String APN) Retrieve the current IPv4 address of the bearer.
static String	GetBearerV4Dns1(String APN) Retrieve the current IPv4 DNS1 address of the bearer.
static String	GetBearerV4Dns2(String APN) Retrieve the current IPv4 DNS2 address of the bearer.
static String	GetBearerV6Addr(String APN)
static String	GetBearerV6Dns1(String APN)
static String	GetBearerV6Dns2(String APN)
static void	hangUp() Triggers closure of all active Java networking bearers, like the networking idle timeout.
static int	hangUp(String APN) Triggers closure of a dedicated networking bearer.
static void	removeListener(BearerControlListener listener) Removes a listener object which has been previously added to the internal list table of listener objects.
static void	removeListenerEx(BearerControlListenerEx listener) Removes a listener object which has been previously added to the internal list table of listener objects.

Methods inherited from class java.lang.Object

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

Method Detail

addListener

public static void addListener(BearerControlListener listener)

Registers listeners to receive bearer state changes. The listener object is an implementation of BearerControlListener interface. Listeners are stored into an internal HashTable.

Parameters:

listener - The BearerControlListener object to be registered.

See Also:

BearerControlListener, removeListener(com.cinterion.io.BearerControlListener)

removeListener

public static void removeListener(BearerControlListener listener)

Removes a listener object which has been previously added to the internal list table of listener objects. After it has been removed from the list it won't be called in case of any bearer state changes any more. If it hasn't been registered before the list will remain unchanged.

Parameters:

listener - The BearerControlListener object to be removed from the list.

See Also:

BearerControlListener, addListener(com.cinterion.io.BearerControlListener)

addListenerEx

public static void addListenerEx(BearerControlListenerEx listener)

Registers listeners to receive bearer state changes. The listener object is an implementation of BearerControlListenerEx interface. Listeners are stored into an internal HashTable. A BearerControlListenerEx object supports more state change informations as a BearerControlListener object

Parameters:

listener - The BearerControlListenerEx object to be registered.

See Also:

BearerControlListenerEx, removeListenerEx(com.cinterion.io.BearerControlListenerEx)

removeListenerEx

public static void removeListenerEx(BearerControlListenerEx listener)

Removes a listener object which has been previously added to the internal list table of listener objects. After it has been removed from the list it won't be called in case of any bearer state changes any more. If it hasn't been registered before the list will remain unchanged.

Parameters:

listener - The BearerControlListenerEx object to be removed from the list.

See Also:

BearerControlListener, addListener(com.cinterion.io.BearerControlListener)

clearListener

public static void clearListener()

Removes all listener objects which have been previously added to the list table of listener objects.

See Also:

BearerControlListener, addListener(com.cinterion.io.BearerControlListener)

hangUp

public static void hangUp()

Triggers closure of all active Java networking bearers, like the networking idle timeout. In case of a packet connection this deactivates all contexts.

hangUp

public static int hangUp(String APN)

Triggers closure of a dedicated networking bearer. A network bearer is identified by its APN. The hangup is done similar to the networking idle timeout. In case of a packet connection this deactivates the context.

Parameters:

APN - a String with the APN which identifies the networking connection

Returns:

0 if a bearer was successfully triggered to close, -1 otherwise.

GetBearerState

public static int GetBearerState(String APN)

Retrieve the current state of the bearer. identified by its APN

Parameters:

APN - a String with the APN which identifies the networking bearer

Returns:

Bearer state if a bearer with this APN exists, -1 otherwise.

GetBearerV4Addr

public static String GetBearerV4Addr(String APN)
                              throws IOException

Retrieve the current IPv4 address of the bearer. identified by its APN

Parameters:

APN - a String with the APN which identifies the networking bearer

Returns:

Bearer IP address if a bearer with this APN exists, and is active, IOException otherwise.

Throws:

IOException

GetBearerV4Dns1

public static String GetBearerV4Dns1(String APN)
                              throws IOException

Retrieve the current IPv4 DNS1 address of the bearer. identified by its APN

Parameters:

APN - a String with the APN which identifies the networking bearer

Returns:

Bearer IPv4 DNS1 address if a bearer with this APN exists, and is active, IOException otherwise.

Throws:

IOException

GetBearerV4Dns2

public static String GetBearerV4Dns2(String APN)
                              throws IOException

Retrieve the current IPv4 DNS2 address of the bearer. identified by its APN

Parameters:

APN - a String with the APN which identifies the networking bearer

Returns:

Bearer IPv4 DNS2 address if a bearer with this APN exists, and is active, IOException otherwise.

Throws:

IOException

GetBearerV6Addr

public static String GetBearerV6Addr(String APN)
                              throws IOException

Throws:

IOException

GetBearerV6Dns1

public static String GetBearerV6Dns1(String APN)
                              throws IOException

Throws:

IOException

GetBearerV6Dns2

public static String GetBearerV6Dns2(String APN)
                              throws IOException

Throws:

IOException

GetBearerList

public static String[] GetBearerList()

Retrieve a string list with all current defined bearers in the system.

Returns:

Bearer string list.