Package tigase.cluster.strategy
Class SMNonCachingAllNodes
- java.lang.Object
-
- tigase.cluster.strategy.SMNonCachingAllNodes
-
- All Implemented Interfaces:
ClusteringStrategyIfc<ConnectionRecord>
,StatisticHolder
,OnlineJidsReporter
public abstract class SMNonCachingAllNodes extends java.lang.Object implements ClusteringStrategyIfc<ConnectionRecord>
Created: May 13, 2009 9:53:44 AM- Author:
- Artur Hefczyc
-
-
Constructor Summary
Constructors Constructor Description SMNonCachingAllNodes()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description boolean
containsJid(BareJID jid)
The method checks whether the given JID is known to the installation, either user connected to local machine or any of the cluster nodes.JID[]
getConnectionIdsForJid(BareJID jid)
Retrieve all connection IDs (CIDs) for the given user.java.util.Set<ConnectionRecord>
getConnectionRecords(BareJID bareJID)
Returns a set with all ConnectionRecords found in the cache for a given user ID, that is BareJID.java.util.List<JID>
getNodesConnected()
The method returns all cluster nodes currently connected to the cluster node.java.util.List<JID>
getNodesForJid(JID jid)
java.util.List<JID>
getNodesForPacketForward(JID fromNode, java.util.Set<JID> visitedNodes, Packet packet)
java.util.List<JID>
getNodesForUserConnect(JID jid)
java.util.List<JID>
getNodesForUserDisconnect(JID jid)
void
getStatistics(StatisticsList list)
Add the strategy statistics to the List.boolean
hasCompleteJidsInfo()
Method checks whether the clustering strategy has a complete JIDs info.protected boolean
isSuitableForForward(Packet packet)
void
nodeConnected(JID jid)
This is a handler method which is called when a new node connects to the cluster.void
nodeDisconnected(JID jid)
This is a handler method which is called when a node disconnects from the cluster.void
setProperties(java.util.Map<java.lang.String,java.lang.Object> props)
Method used to pass configuration parameters to the class.-
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
Methods inherited from interface tigase.cluster.strategy.ClusteringStrategyIfc
getConnectionRecord, getConnectionRecordInstance, getConnectionRecordsByCreationTime, getDefaults, getInfo, handleLocalPacket, handleLocalPresenceSet, handleLocalResourceBind, handleLocalUserChangedConnId, handleLocalUserLogin, handleLocalUserLogout, processPacket, setClusterController
-
Methods inherited from interface tigase.sys.OnlineJidsReporter
containsJidLocally, containsJidLocally
-
Methods inherited from interface tigase.stats.StatisticHolder
everyHour, everyMinute, everySecond, getStatistics, setStatisticsPrefix, statisticExecutedIn
-
-
-
-
Method Detail
-
containsJid
public boolean containsJid(BareJID jid)
Description copied from interface:OnlineJidsReporter
The method checks whether the given JID is known to the installation, either user connected to local machine or any of the cluster nodes. False result does not mean the user is not connected. It means the method does not know anything about the JID. Some clustering strategies may not cache online users information.- Specified by:
containsJid
in interfaceOnlineJidsReporter
- Parameters:
jid
- a user's JID for whom we query information.- Returns:
- true if the user is known as online to the installation, false if the method does not know.
-
nodeConnected
public void nodeConnected(JID jid)
Description copied from interface:ClusteringStrategyIfc
This is a handler method which is called when a new node connects to the cluster.- Specified by:
nodeConnected
in interfaceClusteringStrategyIfc<ConnectionRecord>
- Parameters:
jid
- is a cluster node id.
-
nodeDisconnected
public void nodeDisconnected(JID jid)
Description copied from interface:ClusteringStrategyIfc
This is a handler method which is called when a node disconnects from the cluster.- Specified by:
nodeDisconnected
in interfaceClusteringStrategyIfc<ConnectionRecord>
- Parameters:
jid
- is a cluster node id.
-
getNodesConnected
public java.util.List<JID> getNodesConnected()
Description copied from interface:ClusteringStrategyIfc
The method returns all cluster nodes currently connected to the cluster node.- Specified by:
getNodesConnected
in interfaceClusteringStrategyIfc<ConnectionRecord>
- Returns:
- List of all cluster nodes currently connected to the cluster node.
-
getConnectionIdsForJid
public JID[] getConnectionIdsForJid(BareJID jid)
Description copied from interface:OnlineJidsReporter
Retrieve all connection IDs (CIDs) for the given user.- Specified by:
getConnectionIdsForJid
in interfaceOnlineJidsReporter
- Parameters:
jid
- id of the user for which we want to retrieve the list.- Returns:
- an array of
JID
containing all Connection IDs (CIDs) for the given user.
-
getConnectionRecords
public java.util.Set<ConnectionRecord> getConnectionRecords(BareJID bareJID)
Description copied from interface:ClusteringStrategyIfc
Returns a set with all ConnectionRecords found in the cache for a given user ID, that is BareJID. In other words all user's resources/connectionIDs found in the cache associated with user's account.- Specified by:
getConnectionRecords
in interfaceClusteringStrategyIfc<ConnectionRecord>
- Parameters:
bareJID
- is an instance of the user's BareJID, that is account ID.- Returns:
- a Set instance with all ConnectionRecords found for a given BareJID. Note, the result may be null or it maybe an empty Set or non-empty set.
-
getNodesForPacketForward
public java.util.List<JID> getNodesForPacketForward(JID fromNode, java.util.Set<JID> visitedNodes, Packet packet)
-
getStatistics
public void getStatistics(StatisticsList list)
Description copied from interface:ClusteringStrategyIfc
Add the strategy statistics to the List.- Specified by:
getStatistics
in interfaceClusteringStrategyIfc<ConnectionRecord>
-
hasCompleteJidsInfo
public boolean hasCompleteJidsInfo()
Description copied from interface:OnlineJidsReporter
Method checks whether the clustering strategy has a complete JIDs info. That is whether the strategy knows about all users connected to all nodes. Some strategies may choose not to share this information among nodes, hence the methods returns false. Other may synchronize this information and can provide it to further optimize cluster traffic.- Specified by:
hasCompleteJidsInfo
in interfaceOnlineJidsReporter
- Returns:
- a true boolean value if the strategy has a complete information about all users connected to all cluster nodes.
-
setProperties
public void setProperties(java.util.Map<java.lang.String,java.lang.Object> props)
Description copied from interface:ClusteringStrategyIfc
Method used to pass configuration parameters to the class. Parameters are stored inMap
which contains compiles set of defaults overwritten by parameters loaded from configuration file.
If he implementation took a good care of providing defaults for all parameters no parameter should be missing.- Specified by:
setProperties
in interfaceClusteringStrategyIfc<ConnectionRecord>
- Parameters:
props
- aMap
with all configuration parameters for the class.
-
isSuitableForForward
protected boolean isSuitableForForward(Packet packet)
-
-