abs.ixi.client.net

Class ConnectionManager

java.lang.Object

abs.ixi.client.net.ConnectionManager

public final class ConnectionManager
extends Object

A singleton entity to manage all the Connections within SDK. ConnectionManager is responsibile for instantiation and life-cycle management of the connections. Any connection created outside ConnectionManager (using various constructors of Connection implementations) will not be managed by ConnectionManager which may result in resource leak. Therefore SDK users (applications) SHOULD instantiate Connection using ConnectionManager only. In unstable network environments such as mobile devices, connectivity to server is broken very frequently forcing SDK to reconnect with server. ConnectionManager is the entity which manages reconnection mechanism.However, it is important for ConnectionManager to know if the underlying network is available on device; otherwise the reconnection will be waste of efforts. Therefore, application developers must keep ConnectionManager updated about the status of network availability on device. If the network is not available on device, ConnectionManager will not reconnect broken connections.

Method Summary

Modifier and Type	Method and Description
void	addConnectivityListener(NetConnectivityListener listener) Add a NetConnectivityListener to the listener list maintaned by ConnectionManager
void	addReconnectionListener(ReconnectionListener listener) Add a ReconnectionListener to the listener list maintaned by ConnectionManager
void	closeConnection(Connection conn) Close a Connection.
void	closeFileTransferConnection() Close File transfer connection
void	closeXMPPConnection(boolean closeAll) Close xmpp connection.
boolean	connect(boolean forceConnect, boolean isXMPPConnection) CONNECT is a command for ConnectionManager to re-establish underlying network connection which may be broken.
boolean	connectFileTransferConnection(boolean forceConnect)
boolean	connectXMPPConnection(boolean forceConnect)
SFCMConnection	getFileTransferConnection() Get File Transfer connection held by this ConnectionManager.
static ConnectionManager	getInstance() Get ConnectionManager instance.
XMPPConnection	getXmppConnection() Get XMPP connection held by this ConnectionManager.
static void	instantiate(ConnectionConfig config) ConnectionManager is a singleton entity; it must be instantiated with ConnectionConfig before getInstance() can be invoked.
static void	instantiate(ConnectionConfig xmppConfig, ConnectionConfig mimeConfig) ConnectionManager is a singleton entity; it must be instantiated with ConnectionConfig before getInstance() can be invoked.
static void	instantiate(String xmppHost, int xmppPort) ConnectionManager is a singleton entity; it must be instantiated with ConnectionConfig before getInstance() can be invoked.
static void	instantiate(String xmppHost, int xmppPort, String sfcmHost, int sfcmPort) ConnectionManager is a singleton entity; it must be instantiated with ConnectionConfig before getInstance() can be invoked.
boolean	isNetworkConnectivity() The application may choose to keep ConnectionManager informed about network connectivity on device.
Future<Boolean>	reconnectAsync() Trigger connection reconnect on the persistent connection asynchronously.
void	registerConnectionStateObserver(ConnectionStateObserver o) Register ConnectionStateObserver with Connection Manager
void	setNetworkConnectivity(boolean networkConnectivity) Set network connectivity status.
void	shutdown() Shutdown this connection manager instance.

Methods inherited from class java.lang.Object

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

Method Detail

instantiate

public static void instantiate(ConnectionConfig config)

ConnectionManager is a singleton entity; it must be instantiated with ConnectionConfig before getInstance() can be invoked.

Parameters:

config - xmpp connection configurations

instantiate

public static void instantiate(String xmppHost,
                               int xmppPort)

ConnectionManager is a singleton entity; it must be instantiated with ConnectionConfig before getInstance() can be invoked.

Parameters:

xmppHost - server ip for xmpp service

xmppPort - server port of xmpp service

instantiate

public static void instantiate(ConnectionConfig xmppConfig,
                               ConnectionConfig mimeConfig)

ConnectionManager is a singleton entity; it must be instantiated with ConnectionConfig before getInstance() can be invoked.

Parameters:

xmppConfig - xmpp connection configuration

mimeConfig - file transfer connection configuration

instantiate

public static void instantiate(String xmppHost,
                               int xmppPort,
                               String sfcmHost,
                               int sfcmPort)

ConnectionManager is a singleton entity; it must be instantiated with ConnectionConfig before getInstance() can be invoked.

Parameters:

xmppHost - xmpp service ip address

xmppPort - xmpp service port

sfcmHost - mime service IP address

sfcmPort - mime service port

getInstance

public static ConnectionManager getInstance()

Get ConnectionManager instance. ConnectionManager must be instantiated before this call otherwise it throws NotInitializedException

Returns:

ConnectionManager ConnectionManager

getXmppConnection

public XMPPConnection getXmppConnection()

Get XMPP connection held by this ConnectionManager. It uses ConnectionConfig instance held by the mananger; throws NullPointerException if there is no ConnectionConfig found.

Returns:

XMPPConnection XMPPConnection

getFileTransferConnection

public SFCMConnection getFileTransferConnection()

Get File Transfer connection held by this ConnectionManager. It uses ConnectionConfig instance held by the mananger; throws NullPointerException if there is no ConnectionConfig found.

Returns:

SFCMConnection SFCMConnection

isNetworkConnectivity

public boolean isNetworkConnectivity()

The application may choose to keep ConnectionManager informed about network connectivity on device. Correct status of network connectivity helps optimise the reconnection mechanism in SDK resulting in power saving.

Returns:

a flag indicating netwrok connectivity on device. This may not be the correct status as the ConnectionManager relies on the application update its network connectivity flag as and when there is a change

setNetworkConnectivity

public void setNetworkConnectivity(boolean networkConnectivity)

Set network connectivity status. If the underlying network connectivity is broken, SDK will stop attempting reconnection.

Parameters:

networkConnectivity - networkConnectivity

connectXMPPConnection

public boolean connectXMPPConnection(boolean forceConnect)
                              throws NetworkException

Throws:

NetworkException

connectFileTransferConnection

public boolean connectFileTransferConnection(boolean forceConnect)
                                      throws NetworkException

Throws:

NetworkException

connect

public boolean connect(boolean forceConnect,
                       boolean isXMPPConnection)
                throws NetworkException

CONNECT is a command for ConnectionManager to re-establish underlying network connection which may be broken. If the connection is reconnected, HeartBeatManger for the connection will also be restarted.

Parameters:

forceConnect - if true, a connect operation will be invoked as long as device has network connectivity; If the value is false, connect operation will be triggered only if Connection.isConnected() returns false

isXMPPConnection - true if CONNECT needs to be issued on XMPP Connection otherwise false

Returns:

true if an attempt was made to establish a physical connection and the attempt was successful

Throws:

NetworkException - with NetworkException.Reason.NO_CONNECTIVITY when device has no connectivity; the exception is also thrown if the Connection.connect() operation fails. The NetworkException.Reason specified in this case will be NetworkException.Reason.IO_ERROR

addReconnectionListener

public void addReconnectionListener(ReconnectionListener listener)

Add a ReconnectionListener to the listener list maintaned by ConnectionManager

Parameters:

listener - ReconnectionListener to be added to list

addConnectivityListener

public void addConnectivityListener(NetConnectivityListener listener)

Add a NetConnectivityListener to the listener list maintaned by ConnectionManager

Parameters:

listener - ReconnectionListener to be added to list

registerConnectionStateObserver

public void registerConnectionStateObserver(ConnectionStateObserver o)

Register ConnectionStateObserver with Connection Manager

Parameters:

o - ConnectionStateObserver instance to be registered

reconnectAsync

public Future<Boolean> reconnectAsync()

Trigger connection reconnect on the persistent connection asynchronously. Before starting reconnection process, ReconnectionListeners will be executed. Once reconnection is completed, ReconnectionListener will be notified about success/failure.

Returns:

a future instance with a boolean flag indicating if the reconnection was successful. Null if reconnection is already in progress.

closeConnection

public void closeConnection(Connection conn)

Close a Connection. If it is XMPP connection, file transfer connections will not also be closed.

Parameters:

conn - Connection to be closed

closeXMPPConnection

public void closeXMPPConnection(boolean closeAll)

Close xmpp connection. While closing a xmpp connection, we also close file transfer connection. because file transfer connection is tightly coupled with XMPP connection. For existence of file transfer connection xmpp connection should be already established.

Parameters:

closeAll - flag to indicate of all the connections (inlcuding non-XMPP) should be closed

closeFileTransferConnection

public void closeFileTransferConnection()

Close File transfer connection

shutdown

public void shutdown()

Shutdown this connection manager instance. All the connections are closed prior to shutting down connection manager.