tigase.cluster.strategy

## Class DefaultClusteringStrategyAbstract<E extends ConnectionRecordIfc>

- java.lang.Object
- - tigase.cluster.strategy.DefaultClusteringStrategyAbstract<E>

- Type Parameters:
    `E` -
  All Implemented Interfaces:
    ClusteringStrategyIfc<E>, StatisticHolder, OnlineJidsReporter
  Direct Known Subclasses:
    DefaultClusteringStrategy

      public abstract class DefaultClusteringStrategyAbstract<E extends ConnectionRecordIfc>
      extends Object
      implements ClusteringStrategyIfc<E>

  Created: May 13, 2009 9:53:44 AM
  Version:
    $Rev$
  Author:
    Artur Hefczyc

- - ### Field Summary

    Fields
    Modifier and Type | Field and Description
    --- | ---
    `protected ClusterControllerIfc` | `cluster` Field description
    `protected String` | `comp`
    `protected String` | `prefix`
    `protected SessionManagerClusteredIfc` | `sm` Field description

  - ### Constructor Summary

    Constructors
    Constructor and Description
    `DefaultClusteringStrategyAbstract()` Constructs ...

  - ### Method Summary

    All Methods Instance Methods Concrete Methods Deprecated Methods
    Modifier and Type | Method and Description
    --- | ---
    `void` | `addCommandListener(CommandListener cmd)` 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.
    `boolean` | `containsJidLocally(BareJID jid)` The method checks whether the given JID is known to local cluster node as connected user.
    `boolean` | `containsJidLocally(JID jid)` The method checks whether the given JID is known to local cluster node as connected user.
    `void` | `everyHour()`
    `void` | `everyMinute()`
    `void` | `everySecond()`
    `JID[]` | `getConnectionIdsForJid(BareJID jid)` Retrieve all connection IDs (CIDs) for the given user.
    `E` | `getConnectionRecord(JID jid)` Returns a ConnectionRecord object associated with this user's full JID if it exists in the cache or null if it does not.
    `E` | `getConnectionRecordInstance()` Method description
    `Set<E>` | `getConnectionRecords(BareJID bareJID)` Returns a set with all ConnectionRecords found in the cache for a given user ID, that is BareJID.
    `Map<String,Object>` | `getDefaults(Map<String,Object> params)` This method is used for configuration purpose.
    `String` | `getInfo()` Method description
    `Object` | `getInternalCacheData()` Deprecated.
    `List<JID>` | `getNodesConnected()` The method returns all cluster nodes currently connected to the cluster node.
    `List<JID>` | `getNodesForPacketForward(JID fromNode, Set<JID> visitedNodes, Packet packet)` Method description
    `SessionManagerClusteredIfc` | `getSM()`
    `void` | `getStatistics(StatisticsList list)` Add the strategy statistics to the List.
    `void` | `getStatistics(String compName, StatisticsList list)`
    `void` | `handleLocalPacket(Packet packet, XMPPResourceConnection conn)` Method description
    `void` | `handleLocalPresenceSet(XMPPResourceConnection conn)` Method description
    `void` | `handleLocalResourceBind(XMPPResourceConnection conn)` Method description
    `void` | `handleLocalUserChangedConnId(BareJID userId, XMPPResourceConnection conn, JID oldConnId, JID newConnId)`
    `void` | `handleLocalUserLogin(BareJID userId, XMPPResourceConnection conn)` Method description
    `void` | `handleLocalUserLogout(BareJID userId, XMPPResourceConnection conn)` Method description
    `boolean` | `hasCompleteJidsInfo()` Method checks whether the clustering strategy has a complete JIDs info.
    `protected boolean` | `isSuitableForForward(Packet packet)` Method description
    `boolean` | `processPacket(Packet packet, XMPPResourceConnection conn)` Method description
    `boolean` | `sendToNextNode(JID fromNode, Set<JID> visitedNodes, Map<String,String> data, Packet packet)` Method attempts to send the packet to the next cluster node.
    `void` | `setClusterController(ClusterControllerIfc clComp)` Method description
    `void` | `setProperties(Map<String,Object> props)` Method used to pass configuration parameters to the class.
    `void` | `setSessionManagerHandler(SessionManagerClusteredIfc sm)` The method allows to obtain SessionManagerHandler object by the strategy.
    `void` | `setStatisticsPrefix(String prefix)`
    `void` | `statisticExecutedIn(long executionTime)`
    `String` | `toString()`

    - ### Methods inherited from class java.lang.Object

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

    - ### Methods inherited from interface tigase.cluster.strategy.ClusteringStrategyIfc

      `nodeConnected, nodeDisconnected`

- - ### Field Detail

    - #### comp

          protected String comp

    - #### prefix

          protected String prefix

    - #### cluster

          protected ClusterControllerIfc cluster

      Field description

    - #### sm

          protected SessionManagerClusteredIfc sm

      Field description

  - ### Constructor Detail

    - #### DefaultClusteringStrategyAbstract

          public DefaultClusteringStrategyAbstract()

      Constructs ...

  - ### Method Detail

    - #### statisticExecutedIn

          public void statisticExecutedIn(long executionTime)

      Specified by:
        `statisticExecutedIn` in interface `StatisticHolder`

    - #### everyHour

          public void everyHour()

      Specified by:
        `everyHour` in interface `StatisticHolder`

    - #### everyMinute

          public void everyMinute()

      Specified by:
        `everyMinute` in interface `StatisticHolder`

    - #### everySecond

          public void everySecond()

      Specified by:
        `everySecond` in interface `StatisticHolder`

    - #### getStatistics

          public void getStatistics(String compName,
                                    StatisticsList list)

      Specified by:
        `getStatistics` in interface `StatisticHolder`

    - #### setStatisticsPrefix

          public void setStatisticsPrefix(String prefix)

      Specified by:
        `setStatisticsPrefix` in interface `StatisticHolder`

    - #### addCommandListener

          public final void addCommandListener(CommandListener cmd)

      Method description
      Parameters:
        `cmd` -

    - #### 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 interface `OnlineJidsReporter`
      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.

    - #### containsJidLocally

          public boolean containsJidLocally(BareJID jid)

      Description copied from interface: `OnlineJidsReporter`
      The method checks whether the given JID is known to local cluster node as connected user. False result means that given JID is not connected to local cluster node but it may be connected to other cluster node. Result of this method should be independent of used clustering strategy.
      Specified by:
        `containsJidLocally` in interface `OnlineJidsReporter`
      Parameters:
        `jid` - a user's JID for whom we query information
      Returns:
        true if user is known as connected to local cluster node, false if it is not connected to local node

    - #### containsJidLocally

          public boolean containsJidLocally(JID jid)

      Description copied from interface: `OnlineJidsReporter`
      The method checks whether the given JID is known to local cluster node as connected user. False result means that given JID is not connected to local cluster node but it may be connected to other cluster node. Result of this method should be independent of used clustering strategy.
      Specified by:
        `containsJidLocally` in interface `OnlineJidsReporter`
      Parameters:
        `jid` - a user's JID for whom we query information
      Returns:
        true if user is known as connected to local cluster node, false if it is not connected to local node

    - #### handleLocalPacket

          public void handleLocalPacket(Packet packet,
                                        XMPPResourceConnection conn)

      Description copied from interface: `ClusteringStrategyIfc`
      Method description
      Specified by:
        `handleLocalPacket` in interface `ClusteringStrategyIfc<E extends ConnectionRecordIfc>`

    - #### handleLocalPresenceSet

          public void handleLocalPresenceSet(XMPPResourceConnection conn)

      Description copied from interface: `ClusteringStrategyIfc`
      Method description
      Specified by:
        `handleLocalPresenceSet` in interface `ClusteringStrategyIfc<E extends ConnectionRecordIfc>`

    - #### handleLocalResourceBind

          public void handleLocalResourceBind(XMPPResourceConnection conn)

      Description copied from interface: `ClusteringStrategyIfc`
      Method description
      Specified by:
        `handleLocalResourceBind` in interface `ClusteringStrategyIfc<E extends ConnectionRecordIfc>`

    - #### handleLocalUserLogin

          public void handleLocalUserLogin(BareJID userId,
                                           XMPPResourceConnection conn)

      Description copied from interface: `ClusteringStrategyIfc`
      Method description
      Specified by:
        `handleLocalUserLogin` in interface `ClusteringStrategyIfc<E extends ConnectionRecordIfc>`

    - #### handleLocalUserLogout

          public void handleLocalUserLogout(BareJID userId,
                                            XMPPResourceConnection conn)

      Description copied from interface: `ClusteringStrategyIfc`
      Method description
      Specified by:
        `handleLocalUserLogout` in interface `ClusteringStrategyIfc<E extends ConnectionRecordIfc>`

    - #### handleLocalUserChangedConnId

          public void handleLocalUserChangedConnId(BareJID userId,
                                                   XMPPResourceConnection conn,
                                                   JID oldConnId,
                                                   JID newConnId)

      Specified by:
        `handleLocalUserChangedConnId` in interface `ClusteringStrategyIfc<E extends ConnectionRecordIfc>`

    - #### processPacket

          public boolean processPacket(Packet packet,
                                       XMPPResourceConnection conn)

      Description copied from interface: `ClusteringStrategyIfc`
      Method description
      Specified by:
        `processPacket` in interface `ClusteringStrategyIfc<E extends ConnectionRecordIfc>`
      Returns:
        a value of `boolean`

    - #### sendToNextNode

          public boolean sendToNextNode(JID fromNode,
                                        Set<JID> visitedNodes,
                                        Map<String,String> data,
                                        Packet packet)

      Method attempts to send the packet to the next cluster node. Returns true on successful attempt and false on failure. The true result does not mean that the packet has been delivered though. Only that it was sent. The send attempt may fail if there is no more cluster nodes to send the packet or if the clustering strategy logic decided that the packet does not have to be sent.
      Parameters:
        `fromNode` -
        `data` -
        `packet` - to be sent to a next cluster node
        `visitedNodes` - a list of nodes already visited by the packet.
      Returns:
        true if the packet was sent to next cluster node and false otherwise.

    - #### toString

          public String toString()

      Overrides:
        `toString` in class `Object`

    - #### getNodesConnected

          public List<JID> getNodesConnected()

      Description copied from interface: `ClusteringStrategyIfc`
      The method returns all cluster nodes currently connected to the cluster node.
      Specified by:
        `getNodesConnected` in interface `ClusteringStrategyIfc<E extends ConnectionRecordIfc>`
      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 interface `OnlineJidsReporter`
      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.

    - #### getConnectionRecord

          public E getConnectionRecord(JID jid)

      Description copied from interface: `ClusteringStrategyIfc`
      Returns a ConnectionRecord object associated with this user's full JID if it exists in the cache or null if it does not. All parts of the user's JID are checked and ConnectionRecord is returned only if there is a match for all parts.
      Specified by:
        `getConnectionRecord` in interface `ClusteringStrategyIfc<E extends ConnectionRecordIfc>`
      Parameters:
        `jid` - is an instance of the user's full JID.
      Returns:
        ConnectionRecord instance associated with given user's JID or null if there is no ConnectionRecord in the cache.

    - #### getConnectionRecordInstance

          public E getConnectionRecordInstance()

      Description copied from interface: `ClusteringStrategyIfc`
      Method description
      Specified by:
        `getConnectionRecordInstance` in interface `ClusteringStrategyIfc<E extends ConnectionRecordIfc>`
      Returns:
        a value of `E`

    - #### getConnectionRecords

          public Set<E> 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 interface `ClusteringStrategyIfc<E extends ConnectionRecordIfc>`
      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.

    - #### getDefaults

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

      Description copied from interface: `ClusteringStrategyIfc`
      This method is used for configuration purpose. Following the convention used in the Tigase project this method is supposed to provide configuration defaults. All parameters which exist in configuration file overwrite corresponding default parameters. If some parameters are missing in configuration file defaults are used then. A compiled set of parameters is then passed to `setProperties` method.
      Specified by:
        `getDefaults` in interface `ClusteringStrategyIfc<E extends ConnectionRecordIfc>`
      Parameters:
        `params` - a `Map` with properties loaded from init.properties file which should be used for generating defaults.
      Returns:
        a `Map` with all the class default configuration parameters.

    - #### getInfo

          public String getInfo()

      Description copied from interface: `ClusteringStrategyIfc`
      Method description
      Specified by:
        `getInfo` in interface `ClusteringStrategyIfc<E extends ConnectionRecordIfc>`
      Returns:
        a value of `String`

    - #### getInternalCacheData

          @Deprecated
          public Object getInternalCacheData()

      Deprecated.
      Description copied from interface: `ClusteringStrategyIfc`
      Note! This is not for a common use method. This is for debugging and diagnostic purposes only and maybe removed or changed at any time in the future. It returns a content of an internal cache from the strategy. Regardless of the cache data organization inside the strategy, it is returned here in a common format. It may be a copy or a direct reference to internal data. Therefore this is unmodifiable instance of the cache. Generating results of this structure may be a costly operation, therefore it must not be called frequently.
      Specified by:
        `getInternalCacheData` in interface `ClusteringStrategyIfc<E extends ConnectionRecordIfc>`
      Returns:
        an Object with content of an internal cache data.

    - #### getNodesForPacketForward

          public List<JID> getNodesForPacketForward(JID fromNode,
                                                    Set<JID> visitedNodes,
                                                    Packet packet)

      Method description
      Parameters:
        `fromNode` -
        `visitedNodes` -
        `packet` -
      Returns:
        a value of `List<JID>`

    - #### getStatistics

          public void getStatistics(StatisticsList list)

      Description copied from interface: `ClusteringStrategyIfc`
      Add the strategy statistics to the List.
      Specified by:
        `getStatistics` in interface `ClusteringStrategyIfc<E extends ConnectionRecordIfc>`

    - #### 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 interface `OnlineJidsReporter`
      Returns:
        a true boolean value if the strategy has a complete information about all users connected to all cluster nodes.

    - #### setClusterController

          public void setClusterController(ClusterControllerIfc clComp)

      Description copied from interface: `ClusteringStrategyIfc`
      Method description
      Specified by:
        `setClusterController` in interface `ClusteringStrategyIfc<E extends ConnectionRecordIfc>`

    - #### setProperties

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

      Description copied from interface: `ClusteringStrategyIfc`
      Method used to pass configuration parameters to the class. Parameters are stored in `Map` 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 interface `ClusteringStrategyIfc<E extends ConnectionRecordIfc>`
      Parameters:
        `props` - a `Map` with all configuration parameters for the class.

    - #### setSessionManagerHandler

          public void setSessionManagerHandler(SessionManagerClusteredIfc sm)

      Description copied from interface: `ClusteringStrategyIfc`
      The method allows to obtain SessionManagerHandler object by the strategy. The object is mainly used to access local VHosts configuration and check the ID of the local session manager.
      Specified by:
        `setSessionManagerHandler` in interface `ClusteringStrategyIfc<E extends ConnectionRecordIfc>`
      Parameters:
        `sm` - is an instance of the SessionManagerHandler class.

    - #### isSuitableForForward

          protected boolean isSuitableForForward(Packet packet)

      Method description
      Parameters:
        `packet` -
      Returns:
        a value of `boolean`

    - #### getSM

          public SessionManagerClusteredIfc getSM()

Copyright © 2022 "Tigase, Inc.". All rights reserved.