abs.ixi.client

Class Session

java.lang.Object

abs.ixi.client.Session

All Implemented Interfaces:

Context, DataHolder

public class Session
extends Object
implements Context

Session holds transient data applicable to a user session. It also has a key-value pair based data-store which SDK users can use to store session related data.

There is an EventBus instance which Session contains. The event bus is kept inside session so as to allow multiple user sessions within SDK. Currently SDK support a SINGLE use session.

Author:

Yogi

Field Summary

Fields

Modifier and Type	Field and Description
static String	KEY_DEVICE_TYPE Datastore key for deviceType; session stores underlying device type
static String	KEY_DOMAIN Datastore key for domain (domain in JID)
static String	KEY_IS_SM_SUPPORTED Datastore key for setting isSMSupported
static String	KEY_MAX_RESUMPTION_TIME_IN_SEC Datastore key for max resumption time; resumption time is stored in seconds
static String	KEY_MUC_SERVICE Datastore key for MUC service
static String	KEY_USER_JID Datastore key for user JID
static String	KEY_USER_NAME Datastore key for username
static String	KEY_USER_PASSWORD Datastore key for user password

Constructor Summary

Constructors

Constructor and Description
Session()
Session(EventBus eventBus)

Method Summary

Modifier and Type	Method and Description
void	destroy() Destroys this context after which the context will become unusable.
Object	get(Object key) Returns value associated with this key
Calendar	getCreateTime()
EventBus	getEventBus()
void	invalidate()
boolean	isAuthenticated() Check if the session has been authnticated.
Object	put(Object key, Object val) Store a value associated with given key.
void	reset() Resets Context.
void	setAuthenticated(boolean authenticated)

Methods inherited from class java.lang.Object

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

Field Detail

KEY_USER_NAME

public static final String KEY_USER_NAME

Datastore key for username

See Also:

Constant Field Values

KEY_USER_JID

public static final String KEY_USER_JID

Datastore key for user JID

See Also:

Constant Field Values

KEY_USER_PASSWORD

public static final String KEY_USER_PASSWORD

Datastore key for user password

See Also:

Constant Field Values

KEY_DOMAIN

public static final String KEY_DOMAIN

Datastore key for domain (domain in JID)

See Also:

Constant Field Values

KEY_MUC_SERVICE

public static final String KEY_MUC_SERVICE

Datastore key for MUC service

See Also:

Constant Field Values

KEY_DEVICE_TYPE

public static final String KEY_DEVICE_TYPE

Datastore key for deviceType; session stores underlying device type

See Also:

Constant Field Values

KEY_IS_SM_SUPPORTED

public static final String KEY_IS_SM_SUPPORTED

Datastore key for setting isSMSupported

See Also:

Constant Field Values

KEY_MAX_RESUMPTION_TIME_IN_SEC

public static final String KEY_MAX_RESUMPTION_TIME_IN_SEC

Datastore key for max resumption time; resumption time is stored in seconds

See Also:

Constant Field Values

Constructor Detail

Session

public Session()

Session

public Session(EventBus eventBus)

Method Detail

get

public Object get(Object key)

Description copied from interface: DataHolder

Returns value associated with this key

Specified by:

get in interface DataHolder

Parameters:

key - key for which value will be returned

Returns:

value

put

public Object put(Object key,
                  Object val)

Description copied from interface: DataHolder

Store a value associated with given key.

Specified by:

put in interface DataHolder

Parameters:

key - key

val - value

Returns:

given value if there is no value stored already for the given key otherwise the previous value which will be overwritten

getEventBus

public EventBus getEventBus()

Specified by:

getEventBus in interface Context

Returns:

EventBus instance from the Context

getCreateTime

public Calendar getCreateTime()

reset

public void reset()

Description copied from interface: Context

Resets Context. Resetting Context will flush all the data held by {code Context}. However it will not change the create time of the context.

Specified by:

reset in interface Context

isAuthenticated

public boolean isAuthenticated()

Check if the session has been authnticated. If the session has been authenticated, it stores user credentials to allow auto login until the user credentials are either cleared or invalidated.

Returns:

true if this session has been authenticated otherwise false

setAuthenticated

public void setAuthenticated(boolean authenticated)

invalidate

public void invalidate()

destroy

public void destroy()

Description copied from interface: Context

Destroys this context after which the context will become unusable.

Specified by:

destroy in interface Context