tigase.cluster

## Class ClusterController

- java.lang.Object
- - tigase.server.BasicComponent
  - - tigase.server.AbstractComponentRegistrator<ClusteredComponentIfc>
    - - tigase.cluster.ClusterController

- All Implemented Interfaces:
    ClusterControllerIfc, Configurable, XMPPService, ComponentRegistrator, ServerComponent, VHostListener

      public class ClusterController
      extends AbstractComponentRegistrator<ClusteredComponentIfc>
      implements Configurable, ClusterControllerIfc

  Describe class ClusterController here. Created: Mon Jun 9 20:03:28 2008
  Version:
    $Rev$
  Author:
    Artur Hefczyc

- - ### Field Summary

    Fields
    Modifier and Type | Field and Description
    --- | ---
    `static String` | `MY_DOMAIN_NAME_PROP_KEY` Field description
    `static String` | `MY_DOMAIN_NAME_PROP_VAL` Field description

    - ### Fields inherited from class tigase.server.AbstractComponentRegistrator

      `components`

    - ### Fields inherited from class tigase.server.BasicComponent

      `admins, ALL_PROP_KEY, COMMAND_PROP_NODE, scriptCommands, SCRIPTS_DIR_PROP_DEF, SCRIPTS_DIR_PROP_KEY, vHostManager`

    - ### Fields inherited from interface tigase.conf.Configurable

      `ADMINS_PROP_KEY, AMP_CLASS_NAME, AUTH_DOMAIN_POOL_CLASS, AUTH_REPO_DOMAINS_PROP_KEY, AUTH_REPO_PARAMS_NODE, AUTH_REPO_POOL_CLASS, AUTH_REPO_URL_PROP_KEY, BOSH_CLUST_COMP_CLASS_NAME, BOSH_COMP_CLASS_NAME, C2S_CLUST_COMP_CLASS_NAME, C2S_COMP_CLASS_NAME, CL_COMP_CLASS_NAME, CLUSTER_CONECT, CLUSTER_CONTR_CLASS_NAME, CLUSTER_LISTEN, CLUSTER_MODE, CLUSTER_NODES, CLUSTER_NODES_PROP_KEY, COMP_PROT_CLASS_NAME, COMPONENT_ID_PROP_KEY, DEF_AMP_NAME, DEF_BOSH_NAME, DEF_C2S_NAME, DEF_CL_COMP_NAME, DEF_CLUST_CONTR_NAME, DEF_COMP_PROT_NAME, DEF_EXT_COMP_NAME, DEF_HOSTNAME_PROP_KEY, DEF_MONITOR_NAME, DEF_S2S_NAME, DEF_SM_NAME, DEF_SRECV_NAME, DEF_SSEND_NAME, DEF_STATS_NAME, DEF_VHOST_MAN_NAME, DEF_WS2S_NAME, DERBY_REPO_CLASS_PROP_VAL, DERBY_REPO_URL_PROP_VAL, DRUPAL_REPO_URL_PROP_VAL, DRUPALWP_REPO_CLASS_PROP_VAL, DUMMY_REPO_CLASS_PROP_VAL, EXT_COMP_CLASS_NAME, GEN_ADMINS, GEN_AUTH_DB, GEN_AUTH_DB_URI, GEN_COMP_CLASS, GEN_COMP_NAME, GEN_CONF, GEN_CONFIG, GEN_CONFIG_ALL, GEN_CONFIG_COMP, GEN_CONFIG_CS, GEN_CONFIG_DEF, GEN_CONFIG_SM, GEN_DEBUG, GEN_DEBUG_PACKAGES, GEN_EXT_COMP, GEN_MAX_QUEUE_SIZE, GEN_SCRIPT_DIR, GEN_SM_PLUGINS, GEN_SREC_ADMINS, GEN_SREC_DB, GEN_SREC_DB_URI, GEN_TEST, GEN_TRUSTED, GEN_USER_DB, GEN_USER_DB_URI, GEN_USER_DB_URI_PROP_KEY, GEN_VIRT_HOSTS, HOSTNAMES_PROP_KEY, LIBRESOURCE_REPO_CLASS_PROP_VAL, LIBRESOURCE_REPO_URL_PROP_VAL, MONITOR_CLASS_NAME, MONITOR_CLUST_CLASS_NAME, MONITORING, MYSQL_REPO_CLASS_PROP_VAL, MYSQL_REPO_URL_PROP_VAL, PGSQL_REPO_CLASS_PROP_VAL, PGSQL_REPO_URL_PROP_VAL, ROUTER_COMP_CLASS_NAME, S2S_CLUST_COMP_CLASS_NAME, S2S_COMP_CLASS_NAME, SHARED_AUTH_REPO_PARAMS_PROP_KEY, SHARED_AUTH_REPO_PROP_KEY, SHARED_USER_REPO_PARAMS_PROP_KEY, SHARED_USER_REPO_PROP_KEY, SM_CLUST_COMP_CLASS_NAME, SM_COMP_CLASS_NAME, SRECV_COMP_CLASS_NAME, SSEND_COMP_CLASS_NAME, STANZA_WHITE_CHAR_ACK, STANZA_XMPP_ACK, STATS_CLASS_NAME, STRINGPREP_PROCESSOR, TIGASE_AUTH_REPO_CLASS_PROP_VAL, TIGASE_AUTH_REPO_URL_PROP_VAL, TIGASE_CUSTOM_AUTH_REPO_CLASS_PROP_VAL, TRUSTED_PROP_KEY, USER_DOMAIN_POOL_CLASS, USER_REPO_DOMAINS_PROP_KEY, USER_REPO_PARAMS_NODE, USER_REPO_POOL_CLASS, USER_REPO_POOL_SIZE, USER_REPO_POOL_SIZE_PROP_KEY, USER_REPO_URL_PROP_KEY, VHOST_MAN_CLASS_NAME, VHOST_MAN_CLUST_CLASS_NAME, WS2S_CLASS_NAME, WS2S_CLUST_CLASS_NAME, XML_REPO_CLASS_PROP_VAL, XML_REPO_URL_PROP_VAL, XMPP_STANZA_ACK`

    - ### Fields inherited from interface tigase.cluster.api.ClusterControllerIfc

      `DELIVER_CLUSTER_PACKET_CMD`

    - ### Fields inherited from interface tigase.disco.XMPPService

      `CMD_FEATURES, DEF_FEATURES, INFO_XMLNS, ITEMS_XMLNS`

  - ### Constructor Summary

    Constructors
    Constructor and Description
    `ClusterController()`

  - ### Method Summary

    Methods
    Modifier and Type | Method and Description
    --- | ---
    `void` | `componentAdded(ClusteredComponentIfc component)` Method description
    `void` | `componentRemoved(ClusteredComponentIfc component)` Method description
    `Map<String,Object>` | `getDefaults(Map<String,Object> params)` Method description
    `String` | `getDiscoCategoryType()` Method description
    `String` | `getDiscoDescription()` Method description
    `void` | `handleClusterPacket(tigase.xml.Element packet)` Method description
    `boolean` | `isCorrectType(ServerComponent component)` Method description
    `void` | `nodeConnected(String node)` Method description
    `void` | `nodeDisconnected(String node)` Method description
    `void` | `processPacket(Packet packet, Queue<Packet> results)` Method description
    `void` | `removeCommandListener(CommandListener listener)` Method description
    `void` | `sendToNodes(String command, tigase.xml.Element packet, tigase.xmpp.JID fromNode, Set<tigase.xmpp.JID> visitedNodes, tigase.xmpp.JID... toNodes)` Method description
    `void` | `sendToNodes(String command, tigase.xmpp.JID fromNode, tigase.xmpp.JID... toNodes)` Method description
    `void` | `sendToNodes(String command, Map<String,String> data, tigase.xml.Element packet, tigase.xmpp.JID fromNode, Set<tigase.xmpp.JID> visitedNodes, tigase.xmpp.JID... toNodes)` Method description
    `void` | `sendToNodes(String command, Map<String,String> data, tigase.xmpp.JID fromNode, tigase.xmpp.JID... toNodes)` Method description
    `void` | `sendToNodes(String command, Map<String,String> data, tigase.xmpp.JID fromNode, Set<tigase.xmpp.JID> visitedNodes, tigase.xmpp.JID... toNodes)` Method description
    `void` | `sendToNodes(String command, Map<String,String> data, Queue<tigase.xml.Element> packets, tigase.xmpp.JID fromNode, Set<tigase.xmpp.JID> visitedNodes, tigase.xmpp.JID... toNodes)` Method description
    `void` | `sendToNodes(String command, Queue<tigase.xml.Element> packets, tigase.xmpp.JID fromNode, Set<tigase.xmpp.JID> visitedNodes, tigase.xmpp.JID... toNodes)` Method description
    `void` | `setCommandListener(CommandListener listener)` Method description
    `void` | `setName(String name)` Method description
    `void` | `setProperties(Map<String,Object> properties)` Method description

    - ### Methods inherited from class tigase.server.AbstractComponentRegistrator

      `addComponent, deleteComponent, getComponent, newPacketId, release`

    - ### Methods inherited from class tigase.server.BasicComponent

      `addComponentDomain, canCallCommand, checkCommandAcl, getComponentId, getComponentInfo, getDefHostName, getDefVHostItem, getDiscoCategory, getDiscoFeatures, getDiscoFeatures, getDiscoInfo, getDiscoInfo, getDiscoItems, getDiscoItems, getName, getScriptCommands, getScriptItems, getServiceEntity, getVHostItem, handlesLocalDomains, handlesNameSubdomains, handlesNonLocalDomains, initBindings, initializationCompleted, isAdmin, isInitializationComplete, isLocalDomain, isLocalDomainOrComponent, isNonAdminCommands, isSubdomain, processScriptCommand, removeComponentDomain, removeServiceDiscoveryItem, setVHostManager, updateServiceDiscoveryItem, updateServiceDiscoveryItem, updateServiceDiscoveryItem, updateServiceEntity`

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

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

    - ### Methods inherited from interface tigase.server.ServerComponent

      `getComponentId, getComponentInfo, getName, initializationCompleted, isInitializationComplete, release`

- - ### Field Detail

    - #### MY_DOMAIN_NAME_PROP_KEY

          public static final String MY_DOMAIN_NAME_PROP_KEY

      Field description
      See Also:
        Constant Field Values

    - #### MY_DOMAIN_NAME_PROP_VAL

          public static final String MY_DOMAIN_NAME_PROP_VAL

      Field description
      See Also:
        Constant Field Values

  - ### Constructor Detail

    - #### ClusterController

          public ClusterController()

  - ### Method Detail

    - #### componentAdded

          public void componentAdded(ClusteredComponentIfc component)

      Method description
      Specified by:
        `componentAdded` in class `AbstractComponentRegistrator<ClusteredComponentIfc>`
      Parameters:
        `component` -

    - #### componentRemoved

          public void componentRemoved(ClusteredComponentIfc component)

      Method description
      Specified by:
        `componentRemoved` in class `AbstractComponentRegistrator<ClusteredComponentIfc>`
      Parameters:
        `component` -

    - #### handleClusterPacket

          public void handleClusterPacket(tigase.xml.Element packet)

      Method description
      Specified by:
        `handleClusterPacket` in interface `ClusterControllerIfc`
      Parameters:
        `packet` -

    - #### nodeConnected

          public void nodeConnected(String node)

      Method description
      Specified by:
        `nodeConnected` in interface `ClusterControllerIfc`
      Parameters:
        `node` -

    - #### nodeDisconnected

          public void nodeDisconnected(String node)

      Method description
      Specified by:
        `nodeDisconnected` in interface `ClusterControllerIfc`
      Parameters:
        `node` -

    - #### processPacket

          public void processPacket(Packet packet,
                           Queue<Packet> results)

      Method description
      Specified by:
        `processPacket` in interface `ServerComponent`
      Overrides:
        `processPacket` in class `BasicComponent`
      Parameters:
        `packet` -
        `results` -

    - #### removeCommandListener

          public void removeCommandListener(CommandListener listener)

      Method description
      Specified by:
        `removeCommandListener` in interface `ClusterControllerIfc`
      Parameters:
        `listener` -

    - #### sendToNodes

          public void sendToNodes(String command,
                         Map<String,String> data,
                         Queue<tigase.xml.Element> packets,
                         tigase.xmpp.JID fromNode,
                         Set<tigase.xmpp.JID> visitedNodes,
                         tigase.xmpp.JID... toNodes)

      Method description
      Specified by:
        `sendToNodes` in interface `ClusterControllerIfc`
      Parameters:
        `command` -
        `data` -
        `packets` -
        `fromNode` -
        `visitedNodes` -
        `toNodes` -

    - #### sendToNodes

          public void sendToNodes(String command,
                         Queue<tigase.xml.Element> packets,
                         tigase.xmpp.JID fromNode,
                         Set<tigase.xmpp.JID> visitedNodes,
                         tigase.xmpp.JID... toNodes)

      Method description
      Specified by:
        `sendToNodes` in interface `ClusterControllerIfc`
      Parameters:
        `command` -
        `packets` -
        `fromNode` -
        `visitedNodes` -
        `toNodes` -

    - #### sendToNodes

          public void sendToNodes(String command,
                         Map<String,String> data,
                         tigase.xmpp.JID fromNode,
                         Set<tigase.xmpp.JID> visitedNodes,
                         tigase.xmpp.JID... toNodes)

      Method description
      Specified by:
        `sendToNodes` in interface `ClusterControllerIfc`
      Parameters:
        `command` -
        `data` -
        `fromNode` -
        `visitedNodes` -
        `toNodes` -

    - #### sendToNodes

          public void sendToNodes(String command,
                         Map<String,String> data,
                         tigase.xmpp.JID fromNode,
                         tigase.xmpp.JID... toNodes)

      Method description
      Specified by:
        `sendToNodes` in interface `ClusterControllerIfc`
      Parameters:
        `command` -
        `data` -
        `fromNode` -
        `toNodes` -

    - #### sendToNodes

          public void sendToNodes(String command,
                         tigase.xmpp.JID fromNode,
                         tigase.xmpp.JID... toNodes)

      Method description
      Specified by:
        `sendToNodes` in interface `ClusterControllerIfc`
      Parameters:
        `command` -
        `fromNode` -
        `toNodes` -

    - #### sendToNodes

          public void sendToNodes(String command,
                         tigase.xml.Element packet,
                         tigase.xmpp.JID fromNode,
                         Set<tigase.xmpp.JID> visitedNodes,
                         tigase.xmpp.JID... toNodes)

      Method description
      Specified by:
        `sendToNodes` in interface `ClusterControllerIfc`
      Parameters:
        `command` -
        `packet` -
        `fromNode` -
        `visitedNodes` -
        `toNodes` -

    - #### sendToNodes

          public void sendToNodes(String command,
                         Map<String,String> data,
                         tigase.xml.Element packet,
                         tigase.xmpp.JID fromNode,
                         Set<tigase.xmpp.JID> visitedNodes,
                         tigase.xmpp.JID... toNodes)

      Method description
      Specified by:
        `sendToNodes` in interface `ClusterControllerIfc`
      Parameters:
        `command` -
        `data` -
        `packet` -
        `fromNode` -
        `visitedNodes` -
        `toNodes` -

    - #### getDefaults

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

      Method description
      Specified by:
        `getDefaults` in interface `Configurable`
      Overrides:
        `getDefaults` in class `BasicComponent`
      Parameters:
        `params` -
      Returns:
        a value of `Map`

    - #### getDiscoCategoryType

          public String getDiscoCategoryType()

      Method description
      Overrides:
        `getDiscoCategoryType` in class `BasicComponent`
      Returns:
        a value of `String`

    - #### getDiscoDescription

          public String getDiscoDescription()

      Method description
      Overrides:
        `getDiscoDescription` in class `BasicComponent`
      Returns:
        a value of `String`

    - #### isCorrectType

          public boolean isCorrectType(ServerComponent component)

      Method description
      Specified by:
        `isCorrectType` in class `AbstractComponentRegistrator<ClusteredComponentIfc>`
      Parameters:
        `component` -
      Returns:
        a value of `boolean`

    - #### setCommandListener

          public void setCommandListener(CommandListener listener)

      Method description
      Specified by:
        `setCommandListener` in interface `ClusterControllerIfc`
      Parameters:
        `listener` -

    - #### setName

          public void setName(String name)

      Method description
      Specified by:
        `setName` in interface `ServerComponent`
      Overrides:
        `setName` in class `BasicComponent`
      Parameters:
        `name` -

    - #### setProperties

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

      Method description
      Specified by:
        `setProperties` in interface `Configurable`
      Overrides:
        `setProperties` in class `BasicComponent`
      Parameters:
        `properties` -

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