tigase.cluster.strategy

Class OnlineUsersCachingStrategy

java.lang.Object

tigase.cluster.strategy.DefaultClusteringStrategyAbstract<ConnectionRecordExt>

tigase.cluster.strategy.OnlineUsersCachingStrategy

All Implemented Interfaces:

tigase.cluster.strategy.ClusteringStrategyIfc<ConnectionRecordExt>, tigase.sys.OnlineJidsReporter

public class OnlineUsersCachingStrategy
extends tigase.cluster.strategy.DefaultClusteringStrategyAbstract<ConnectionRecordExt>

Created: Jun 27, 2009 9:42:40 PM

Version:

$Rev$

Author:

Artur Hefczyc

Field Summary

Fields

Modifier and Type	Field and Description
protected static tigase.licence.LicenceChecker	licenceChecker
static String	ONLINE_PRESENCE_CACHE_PROP_KEY Field description
static String	REQUEST_SYNCONLINE_CMD Field description
static String	RESPOND_SYNCONLINE_CMD Field description
static String	STRATEGY_STATS_CMD Field description
static String	USER_CONNECTED_CMD Field description
static String	USER_DISCONNECTED_CMD Field description
static String	USER_PRESENCE_CMD Field description

Fields inherited from class tigase.cluster.strategy.DefaultClusteringStrategyAbstract

cl_nodes_list, cluster, sm

Constructor Summary

Constructors

Constructor and Description
OnlineUsersCachingStrategy() Constructs ...

Method Summary

Methods

Modifier and Type	Method and Description
boolean	containsJid(tigase.xmpp.BareJID jid) Method description
List<tigase.xmpp.JID>	getAllNodes() Method description
tigase.cluster.api.ClusterControllerIfc	getCluster() Method description
tigase.xmpp.JID[]	getConnectionIdsForJid(tigase.xmpp.BareJID jid) Method description
ConnectionRecordExt	getConnectionRecord(tigase.xmpp.JID jid) Method description
ConnectionRecordExt	getConnectionRecordInstance() Method description
Set<ConnectionRecordExt>	getConnectionRecords(tigase.xmpp.BareJID bareJID) Method description
Map<String,Object>	getDefaults(Map<String,Object> params) Method description
String	getInfo() Method description
Object	getInternalCacheData() Deprecated.
List<tigase.xmpp.JID>	getNodesForJid(tigase.xmpp.JID jid) Method description
List<tigase.xmpp.JID>	getNodesForPacketForward(tigase.xmpp.JID fromNode, Set<tigase.xmpp.JID> visitedNodes, tigase.server.Packet packet) Method description
List<tigase.xmpp.JID>	getNodesForUserConnect(tigase.xmpp.JID jid) Method description
List<tigase.xmpp.JID>	getNodesForUserDisconnect(tigase.xmpp.JID jid) Method description
tigase.cluster.api.SessionManagerClusteredIfc	getSM() Method description
void	getStatistics(tigase.stats.StatisticsList list) Method description
void	handleLocalPacket(tigase.server.Packet packet, tigase.xmpp.XMPPResourceConnection conn) Method description
void	handleLocalResourceBind(tigase.xmpp.XMPPResourceConnection conn) Method description
void	handleLocalUserLogout(tigase.xmpp.BareJID userId, tigase.xmpp.XMPPResourceConnection conn) Method description
boolean	hasCompleteJidsInfo() Method description
void	nodeConnected(tigase.xmpp.JID node) Method description
void	nodeDisconnected(tigase.xmpp.JID node) Method description
protected Map<String,String>	prepareConnectionParams(tigase.xmpp.XMPPResourceConnection conn) A utility method used to prepare a Map of data with user session data before it can be sent over to another cluster node.
protected boolean	presenceStatusUpdate(tigase.server.Packet packet) Method description
void	presenceUpdate(tigase.xml.Element presence, ConnectionRecordExt rec) Method description
protected void	requestSync(tigase.xmpp.JID node) Send synchronization request to a given cluster node.
void	setProperties(Map<String,Object> props) Method description
String	toString() Method description
void	userDisconnected(ConnectionRecordExt rec) Method description
void	usersConnected(ConnectionRecordExt... recs) Method description

Methods inherited from class tigase.cluster.strategy.DefaultClusteringStrategyAbstract

addCommandListener, handleLocalPresenceSet, handleLocalUserLogin, isSuitableForForward, processPacket, sendToNextNode, setClusterController, setSessionManagerHandler

Methods inherited from class java.lang.Object

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

Field Detail

ONLINE_PRESENCE_CACHE_PROP_KEY

public static final String ONLINE_PRESENCE_CACHE_PROP_KEY

Field description

See Also:

Constant Field Values

REQUEST_SYNCONLINE_CMD

public static final String REQUEST_SYNCONLINE_CMD

Field description

See Also:

Constant Field Values

RESPOND_SYNCONLINE_CMD

public static final String RESPOND_SYNCONLINE_CMD

Field description

See Also:

Constant Field Values

STRATEGY_STATS_CMD

public static final String STRATEGY_STATS_CMD

Field description

See Also:

Constant Field Values

USER_CONNECTED_CMD

public static final String USER_CONNECTED_CMD

Field description

See Also:

Constant Field Values

USER_DISCONNECTED_CMD

public static final String USER_DISCONNECTED_CMD

Field description

See Also:

Constant Field Values

USER_PRESENCE_CMD

public static final String USER_PRESENCE_CMD

Field description

See Also:

Constant Field Values

licenceChecker

protected static tigase.licence.LicenceChecker licenceChecker

Constructor Detail

OnlineUsersCachingStrategy

public OnlineUsersCachingStrategy()

Constructs ...

Method Detail

containsJid

public boolean containsJid(tigase.xmpp.BareJID jid)

Method description

Specified by:

containsJid in interface tigase.sys.OnlineJidsReporter

Overrides:

containsJid in class tigase.cluster.strategy.DefaultClusteringStrategyAbstract<ConnectionRecordExt>

Parameters:

jid -

Returns:

a value of boolean

handleLocalPacket

public void handleLocalPacket(tigase.server.Packet packet,
                     tigase.xmpp.XMPPResourceConnection conn)

Method description

Specified by:

handleLocalPacket in interface tigase.cluster.strategy.ClusteringStrategyIfc<ConnectionRecordExt>

Overrides:

handleLocalPacket in class tigase.cluster.strategy.DefaultClusteringStrategyAbstract<ConnectionRecordExt>

Parameters:

packet -

conn -

handleLocalUserLogout

public void handleLocalUserLogout(tigase.xmpp.BareJID userId,
                         tigase.xmpp.XMPPResourceConnection conn)

Method description

Specified by:

handleLocalUserLogout in interface tigase.cluster.strategy.ClusteringStrategyIfc<ConnectionRecordExt>

Overrides:

handleLocalUserLogout in class tigase.cluster.strategy.DefaultClusteringStrategyAbstract<ConnectionRecordExt>

Parameters:

userId -

conn -

handleLocalResourceBind

public void handleLocalResourceBind(tigase.xmpp.XMPPResourceConnection conn)

Method description

Specified by:

handleLocalResourceBind in interface tigase.cluster.strategy.ClusteringStrategyIfc<ConnectionRecordExt>

Overrides:

handleLocalResourceBind in class tigase.cluster.strategy.DefaultClusteringStrategyAbstract<ConnectionRecordExt>

Parameters:

conn -

nodeConnected

public void nodeConnected(tigase.xmpp.JID node)

Method description

Specified by:

nodeConnected in interface tigase.cluster.strategy.ClusteringStrategyIfc<ConnectionRecordExt>

Overrides:

nodeConnected in class tigase.cluster.strategy.DefaultClusteringStrategyAbstract<ConnectionRecordExt>

Parameters:

node -

nodeDisconnected

public void nodeDisconnected(tigase.xmpp.JID node)

Method description

Specified by:

nodeDisconnected in interface tigase.cluster.strategy.ClusteringStrategyIfc<ConnectionRecordExt>

Overrides:

nodeDisconnected in class tigase.cluster.strategy.DefaultClusteringStrategyAbstract<ConnectionRecordExt>

Parameters:

node -

presenceUpdate

public void presenceUpdate(tigase.xml.Element presence,
                  ConnectionRecordExt rec)

Method description

Parameters:

presence -

rec -

toString

public String toString()

Method description

Overrides:

toString in class tigase.cluster.strategy.DefaultClusteringStrategyAbstract<ConnectionRecordExt>

Returns:

a value of String

userDisconnected

public void userDisconnected(ConnectionRecordExt rec)

Method description

Parameters:

rec -

usersConnected

public void usersConnected(ConnectionRecordExt... recs)

Method description

Parameters:

recs -

getAllNodes

public List<tigase.xmpp.JID> getAllNodes()

Method description

Specified by:

getAllNodes in interface tigase.cluster.strategy.ClusteringStrategyIfc<ConnectionRecordExt>

Overrides:

getAllNodes in class tigase.cluster.strategy.DefaultClusteringStrategyAbstract<ConnectionRecordExt>

Returns:

a value of List

getCluster

public tigase.cluster.api.ClusterControllerIfc getCluster()

Method description

Returns:

a value of ClusterControllerIfc

getConnectionIdsForJid

public tigase.xmpp.JID[] getConnectionIdsForJid(tigase.xmpp.BareJID jid)

Method description

Specified by:

getConnectionIdsForJid in interface tigase.sys.OnlineJidsReporter

Overrides:

getConnectionIdsForJid in class tigase.cluster.strategy.DefaultClusteringStrategyAbstract<ConnectionRecordExt>

Parameters:

jid -

Returns:

a value of JID[]

getConnectionRecord

public ConnectionRecordExt getConnectionRecord(tigase.xmpp.JID jid)

Method description

Specified by:

getConnectionRecord in interface tigase.cluster.strategy.ClusteringStrategyIfc<ConnectionRecordExt>

Overrides:

getConnectionRecord in class tigase.cluster.strategy.DefaultClusteringStrategyAbstract<ConnectionRecordExt>

Parameters:

jid -

Returns:

a value of ConnectionRecordExt

getConnectionRecordInstance

public ConnectionRecordExt getConnectionRecordInstance()

Method description

Specified by:

getConnectionRecordInstance in interface tigase.cluster.strategy.ClusteringStrategyIfc<ConnectionRecordExt>

Overrides:

getConnectionRecordInstance in class tigase.cluster.strategy.DefaultClusteringStrategyAbstract<ConnectionRecordExt>

Returns:

a value of E

getConnectionRecords

public Set<ConnectionRecordExt> getConnectionRecords(tigase.xmpp.BareJID bareJID)

Method description

Specified by:

getConnectionRecords in interface tigase.cluster.strategy.ClusteringStrategyIfc<ConnectionRecordExt>

Overrides:

getConnectionRecords in class tigase.cluster.strategy.DefaultClusteringStrategyAbstract<ConnectionRecordExt>

Parameters:

bareJID -

Returns:

a value of Set

getDefaults

public Map<String,Object> getDefaults(Map<String,Object> params)

Method description

Specified by:

getDefaults in interface tigase.cluster.strategy.ClusteringStrategyIfc<ConnectionRecordExt>

Overrides:

getDefaults in class tigase.cluster.strategy.DefaultClusteringStrategyAbstract<ConnectionRecordExt>

Parameters:

params -

Returns:

a value of Map

getInfo

public String getInfo()

Method description

Specified by:

getInfo in interface tigase.cluster.strategy.ClusteringStrategyIfc<ConnectionRecordExt>

Overrides:

getInfo in class tigase.cluster.strategy.DefaultClusteringStrategyAbstract<ConnectionRecordExt>

Returns:

a value of String

getInternalCacheData

@Deprecated
public Object getInternalCacheData()

Deprecated.

Method description

Specified by:

getInternalCacheData in interface tigase.cluster.strategy.ClusteringStrategyIfc<ConnectionRecordExt>

Overrides:

getInternalCacheData in class tigase.cluster.strategy.DefaultClusteringStrategyAbstract<ConnectionRecordExt>

Returns:

a value of Object

getNodesForJid

public List<tigase.xmpp.JID> getNodesForJid(tigase.xmpp.JID jid)

Method description

Parameters:

jid -

Returns:

a value of List

getNodesForPacketForward

public List<tigase.xmpp.JID> getNodesForPacketForward(tigase.xmpp.JID fromNode,
                                             Set<tigase.xmpp.JID> visitedNodes,
                                             tigase.server.Packet packet)

Method description

Overrides:

getNodesForPacketForward in class tigase.cluster.strategy.DefaultClusteringStrategyAbstract<ConnectionRecordExt>

Parameters:

fromNode -

visitedNodes -

packet -

Returns:

a value of List

getNodesForUserConnect

public List<tigase.xmpp.JID> getNodesForUserConnect(tigase.xmpp.JID jid)

Method description

Parameters:

jid -

Returns:

a value of List

getNodesForUserDisconnect

public List<tigase.xmpp.JID> getNodesForUserDisconnect(tigase.xmpp.JID jid)

Method description

Parameters:

jid -

Returns:

a value of List

getSM

public tigase.cluster.api.SessionManagerClusteredIfc getSM()

Method description

Returns:

a value of SessionManagerClusteredIfc

getStatistics

public void getStatistics(tigase.stats.StatisticsList list)

Method description

Specified by:

getStatistics in interface tigase.cluster.strategy.ClusteringStrategyIfc<ConnectionRecordExt>

Overrides:

getStatistics in class tigase.cluster.strategy.DefaultClusteringStrategyAbstract<ConnectionRecordExt>

Parameters:

list -

hasCompleteJidsInfo

public boolean hasCompleteJidsInfo()

Method description

Specified by:

hasCompleteJidsInfo in interface tigase.sys.OnlineJidsReporter

Overrides:

hasCompleteJidsInfo in class tigase.cluster.strategy.DefaultClusteringStrategyAbstract<ConnectionRecordExt>

Returns:

a value of boolean

setProperties

public void setProperties(Map<String,Object> props)

Method description

Specified by:

setProperties in interface tigase.cluster.strategy.ClusteringStrategyIfc<ConnectionRecordExt>

Overrides:

setProperties in class tigase.cluster.strategy.DefaultClusteringStrategyAbstract<ConnectionRecordExt>

Parameters:

props -

prepareConnectionParams

protected Map<String,String> prepareConnectionParams(tigase.xmpp.XMPPResourceConnection conn)
                                              throws tigase.xmpp.NotAuthorizedException,
                                                     tigase.xmpp.NoConnectionIdException

A utility method used to prepare a Map of data with user session data before it can be sent over to another cluster node. This is supposed to contain all the user's session essential information which directly identify user's resource and network connection. This information allows to detect two different user's connection made for the same resource. This may happen if both connections are established to different nodes.

Parameters:

conn - is user's XMPPResourceConnection for which Map structure is prepare. a Map structure with all user's connection essential data.

Returns:

a value of Map

Throws:

tigase.xmpp.NoConnectionIdException

tigase.xmpp.NotAuthorizedException

presenceStatusUpdate

protected boolean presenceStatusUpdate(tigase.server.Packet packet)

Method description

Parameters:

packet -

Returns:

a value of boolean

requestSync

protected void requestSync(tigase.xmpp.JID node)

Send synchronization request to a given cluster node. In a response the remote node should return a list of JIDs for online users on this node.

Parameters:

node - is a JID of the target cluster node.