abs.ixi.client

Class Platform

java.lang.Object

abs.ixi.client.Platform

public final class Platform
extends Object

Custodian class which keeps all top level entity instances along with user Session.

By design, Platform is singleton; there will be one platform instance in memory at any given point

Field Summary

Fields

Modifier and Type	Field and Description
static String	CHAT
static String	DOT

Method Summary

Modifier and Type	Method and Description
static void	addEventHandler(Event.EventType type, EventHandler handler) Convenience method to add EventHandler to EventBus in session
static <E extends Event> void	addEventListener(Class<E> eventClz, EventListener<E> listener) Convenience method to add EventListener to EventBus in session
void	addUndeliveredStanzaManager(UndeliveredStanzaManager undeliveredStanzaManager)
void	clearUserSession() Clears user session data.
static Object	get(String key) Convenience method to get stored value for some key.
ChatManager	getChatManager()
String	getDomain() Returns domain name
static Platform	getInstance()
JID	getJabberSearchServiceJID()
int	getMaxResumptionTimeInSec(int defaultValue)
JID	getMucServiceJID() Returns MUC service JID
String	getMucServiceName() Returns MUC service name
PresenceManager	getPresenceManager()
ResponseCorrelator	getResponseCorrelator()
JID	getServerJID() Returns domain name
UndeliveredStanzaManager	getUndeliveredStanzaManager()
JID	getUserJID() Return logged in user's JID
UserManager	getUserManager()
String	getUserName() Return logged in user's name
Session	getUserSession()
static boolean	initialize(SDKInitializer initializer) Initialize SDK Platform.
boolean	isSMSupported(boolean defaultValue)
boolean	isUserAuthenticated() Return user is authenticated or not on current stream.
StreamNegotiator.NegotiationResult	login(String userName, String domain, String passwd) Start XMPP stream with given user credentials.
void	login(String userName, String domain, String passwd, Callback<StreamNegotiator.NegotiationResult,Exception> callback) Start XMPP stream with given user credentials.
void	logout() User logout is protocol level action which simply closes the ongoing stream with server.
static void	put(String key, Object value) Convenience method to store some key values in user session.
static void	raiseEvent(Event.EventType type, Object source) Raise event which is fired on the event bus held by the user session
boolean	registerPacketCollector(PacketCollector collector, String fName) Register a PacketCollector with a PacketForwarder to tap into the packet stream
static void	removeEventHandler(Event.EventType type, EventHandler handler) Convenience method to remove EventHandler to EventBus in session
void	removeUndeliveredStanzaManager()
void	setIsSMSupported(boolean isSupported)
void	setMaxResumptionTimeInSec(int maxResumptionTimeInSec)
void	shutdown() Shutdown this platform instance; this action is irreversible.

Methods inherited from class java.lang.Object

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

Field Detail

CHAT

public static final String CHAT

See Also:

Constant Field Values

DOT

public static final String DOT

See Also:

Constant Field Values

Method Detail

getInstance

public static Platform getInstance()

Returns:

Platform instance; if the Platform has not been initialized using initialize(SDKInitializer) before invoking this method, the call will throw NotInitializedException which is a RuntimeException

initialize

public static boolean initialize(SDKInitializer initializer)
                          throws InitializationErrorException

Initialize SDK Platform. This is the entry point of SDK. If the Platform is not initialized before its use, any attempt to operate with Platform will throw NotInitializedException

Parameters:

initializer - SDKInitializer instance which will be used by the Platform to instantiate SDK objects

Returns:

true if platform was initilized successfully otherwise false

Throws:

InitializationErrorException - indicating platform initialization failure

clearUserSession

public void clearUserSession()

Clears user session data.

getUserJID

public JID getUserJID()

Return logged in user's JID

Returns:

User JID

getUserName

public String getUserName()

Return logged in user's name

Returns:

name of the user

getDomain

public String getDomain()

Returns domain name

Returns:

domain of the user

getServerJID

public JID getServerJID()
                 throws InvalidJabberId

Returns domain name

Returns:

JID of the server

Throws:

InvalidJabberId - if the JID format is not correct

getMucServiceName

public String getMucServiceName()

Returns MUC service name

Returns:

service name

getMucServiceJID

public JID getMucServiceJID()
                     throws InvalidJabberId

Returns MUC service JID

Returns:

MUC Service JID

Throws:

InvalidJabberId - if the JID instantiation fails

getJabberSearchServiceJID

public JID getJabberSearchServiceJID()

addUndeliveredStanzaManager

public void addUndeliveredStanzaManager(UndeliveredStanzaManager undeliveredStanzaManager)

removeUndeliveredStanzaManager

public void removeUndeliveredStanzaManager()

getUndeliveredStanzaManager

public UndeliveredStanzaManager getUndeliveredStanzaManager()

setIsSMSupported

public void setIsSMSupported(boolean isSupported)

isSMSupported

public boolean isSMSupported(boolean defaultValue)

setMaxResumptionTimeInSec

public void setMaxResumptionTimeInSec(int maxResumptionTimeInSec)

getMaxResumptionTimeInSec

public int getMaxResumptionTimeInSec(int defaultValue)

put

public static void put(String key,
                       Object value)

Convenience method to store some key values in user session.

Parameters:

key - String key

value - value object

get

public static Object get(String key)

Convenience method to get stored value for some key.

Parameters:

key - key for the value to be retrieved

Returns:

value object instance if found otherwise null

raiseEvent

public static void raiseEvent(Event.EventType type,
                              Object source)

Raise event which is fired on the event bus held by the user session

Parameters:

type - type of the event to be raised

source - source object instance

addEventListener

public static <E extends Event> void addEventListener(Class<E> eventClz,
                                                      EventListener<E> listener)

Convenience method to add EventListener to EventBus in session

Type Parameters:

E - generic

Parameters:

eventClz - event class for which event listener will be invoked

listener - event listener instance

addEventHandler

public static void addEventHandler(Event.EventType type,
                                   EventHandler handler)

Convenience method to add EventHandler to EventBus in session

Parameters:

type - Event.EventType

handler - EventHandler instance

removeEventHandler

public static void removeEventHandler(Event.EventType type,
                                      EventHandler handler)

Convenience method to remove EventHandler to EventBus in session

Parameters:

type - Event.EventType

handler - EventHandler instance

registerPacketCollector

public boolean registerPacketCollector(PacketCollector collector,
                                       String fName)

Register a PacketCollector with a PacketForwarder to tap into the packet stream

Parameters:

collector - PacketCollector to be registered

fName - PacketForwarder name

Returns:

true if PacketForwarder was found registered with Platform and given collector was registered with the forwarder otherwise false

login

public StreamNegotiator.NegotiationResult login(String userName,
                                                String domain,
                                                String passwd)
                                         throws NetworkException

Start XMPP stream with given user credentials. Stream negotiations are done synchronously; therefore method call will return only when negotiation process is complete.

Parameters:

userName - userName of the user trying to login

passwd - user password

domain - user domain in which user will login

Returns:

StreamNegotiator.NegotiationResult instance with stream negotiation outcome

Throws:

NetworkException - if IO error occurs while reading/writing on connection

login

public void login(String userName,
                  String domain,
                  String passwd,
                  Callback<StreamNegotiator.NegotiationResult,Exception> callback)

Start XMPP stream with given user credentials. Once stream negotiation is complete, Callback will be invoked with StreamNegotiator.NegotiationResult object which application can process to find out the exact outcome of the negotiation process.

During negotiations, if IO error occurs while writing/reading on/from socket, Callback will be invoked with NetworkException. Additionally, if the underlying device does not have network connectivity, Callback will be invoked with NetworkException with NetworkException.Reason.NO_CONNECTIVITY

Parameters:

userName - userName of the user trying to login

domain - user domain in which user will login

passwd - user password

callback - callback implementation to be invoked

isUserAuthenticated

public boolean isUserAuthenticated()

Return user is authenticated or not on current stream.

Returns:

true if current user has already been authenticated otherwise false

getUserSession

public Session getUserSession()

Returns:

Session instance

getChatManager

public ChatManager getChatManager()

Returns:

ChatManager instance

getPresenceManager

public PresenceManager getPresenceManager()

Returns:

PresenceManager instance

getUserManager

public UserManager getUserManager()

Returns:

UserManager instance

getResponseCorrelator

public ResponseCorrelator getResponseCorrelator()

Returns:

ResponseCorrelator instance

logout

public void logout()
            throws NetworkException

User logout is protocol level action which simply closes the ongoing stream with server.

Throws:

NetworkException - when there is any network related error

shutdown

public void shutdown()

Shutdown this platform instance; this action is irreversible. As part of platform shutdown, all the manager entities (UserManager, ChatManager and PresenceManager) along with XMPP Stream are shutdown and connections are closed.

Once the Platform is shutdown, it's state can not be reconstructed; therefore it's the final call to the Platform. Typically when application is getting removed from memeory, Platform will be shutdown. For actions such as user logout, the platform should also be logged out instead of shutdown.