tigase.conf

## Class ConfiguratorAbstract

- java.lang.Object
- - tigase.server.BasicComponent
  - - tigase.server.AbstractComponentRegistrator<Configurable>
    - - tigase.conf.ConfiguratorAbstract

- All Implemented Interfaces:
    Configurable, RepositoryChangeListenerIfc<ConfigItem>, XMPPService, ComponentRegistrator, ServerComponent, VHostListener
  Direct Known Subclasses:
    Configurator, ConfiguratorOld

      public abstract class ConfiguratorAbstract
      extends AbstractComponentRegistrator<Configurable>
      implements RepositoryChangeListenerIfc<ConfigItem>

  Created: Dec 7, 2009 4:15:31 PM
  Version:
    $Rev$
  Author:
    Artur Hefczyc

- - ### Field Summary

    Fields
    Modifier and Type | Field and Description
    --- | ---
    `static String` | `AUTH_DOMAIN_POOL_CLASS_PROP_KEY` Deprecated. moved to RepositoryFactory
    `static String` | `AUTH_DOMAIN_POOL_CLASS_PROP_VAL` Deprecated. moved to RepositoryFactory
    `static String` | `CONFIG_REPO_CLASS_INIT_KEY` Field description
    `static String` | `CONFIG_REPO_CLASS_PROP_KEY` Field description
    `static String` | `INIT_PROPERTIES_MAP_BIND` Field description
    `static String` | `logManagerConfiguration` Field description
    `static String` | `PROPERTY_FILENAME_PROP_KEY` Field description
    `static String` | `USER_DOMAIN_POOL_CLASS_PROP_KEY` Deprecated. moved to RepositoryFactory
    `static String` | `USER_DOMAIN_POOL_CLASS_PROP_VAL` Deprecated. moved to RepositoryFactory

    - ### 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.disco.XMPPService

      `CMD_FEATURES, DEF_FEATURES, INFO_XMLNS, ITEMS_XMLNS`

  - ### Constructor Summary

    Constructors
    Constructor and Description
    `ConfiguratorAbstract()`

  - ### Method Summary

    Methods
    Modifier and Type | Method and Description
    --- | ---
    `void` | `componentAdded(Configurable component)` Method description
    `void` | `componentRemoved(Configurable component)` Method description
    `Map<String,Object>` | `getDefaults(Map<String,Object> params)` Returns default configuration settings in case if there is no configuration file.
    `Map<String,Object>` | `getDefConfigParams()` Method description
    `String` | `getMessageRouterClassName()` Method description
    `static Object` | `getMXBean(String objName)` Method description
    `Map<String,Object>` | `getProperties(String nodeId)` Method description
    `void` | `init(String[] args)` Method description
    `void` | `initBindings(Bindings binds)` Initialize a mapping of key/value pairs which can be used in scripts loaded by the server
    `void` | `initializationCompleted()` Method description
    `boolean` | `isCorrectType(ServerComponent component)` Method description
    `void` | `itemAdded(ConfigItem item)` Method description
    `void` | `itemRemoved(ConfigItem item)` Method description
    `void` | `itemUpdated(ConfigItem item)` Method description
    `static void` | `loadLogManagerConfig(String config)` Method description
    `void` | `parseArgs(String[] args)` Method description
    `static void` | `putMXBean(String objName, Object bean)` Method description
    `void` | `putProperties(String compId, Map<String,Object> props)` Method description
    `void` | `setProperties(Map<String,Object> props)` Sets all configuration properties for object.
    `void` | `setup(Configurable component)` 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, getDiscoCategoryType, getDiscoDescription, getDiscoFeatures, getDiscoFeatures, getDiscoInfo, getDiscoInfo, getDiscoItems, getDiscoItems, getName, getScriptCommands, getScriptItems, getServiceEntity, getVHostItem, handlesLocalDomains, handlesNameSubdomains, handlesNonLocalDomains, isAdmin, isInitializationComplete, isLocalDomain, isLocalDomainOrComponent, isNonAdminCommands, isSubdomain, processPacket, processScriptCommand, removeComponentDomain, removeServiceDiscoveryItem, setName, 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, isInitializationComplete, processPacket, setName`

- - ### Field Detail

    - #### AUTH_DOMAIN_POOL_CLASS_PROP_KEY

          @Deprecated
          public static final String AUTH_DOMAIN_POOL_CLASS_PROP_KEY

      Deprecated. moved to RepositoryFactory
      Field description
      See Also:
        Constant Field Values

    - #### AUTH_DOMAIN_POOL_CLASS_PROP_VAL

          @Deprecated
          public static final String AUTH_DOMAIN_POOL_CLASS_PROP_VAL

      Deprecated. moved to RepositoryFactory
      Field description
      See Also:
        Constant Field Values

    - #### CONFIG_REPO_CLASS_INIT_KEY

          public static final String CONFIG_REPO_CLASS_INIT_KEY

      Field description
      See Also:
        Constant Field Values

    - #### CONFIG_REPO_CLASS_PROP_KEY

          public static final String CONFIG_REPO_CLASS_PROP_KEY

      Field description
      See Also:
        Constant Field Values

    - #### INIT_PROPERTIES_MAP_BIND

          public static final String INIT_PROPERTIES_MAP_BIND

      Field description
      See Also:
        Constant Field Values

    - #### logManagerConfiguration

          public static String logManagerConfiguration

      Field description

    - #### PROPERTY_FILENAME_PROP_KEY

          public static final String PROPERTY_FILENAME_PROP_KEY

      Field description
      See Also:
        Constant Field Values

    - #### USER_DOMAIN_POOL_CLASS_PROP_KEY

          @Deprecated
          public static final String USER_DOMAIN_POOL_CLASS_PROP_KEY

      Deprecated. moved to RepositoryFactory
      Field description
      See Also:
        Constant Field Values

    - #### USER_DOMAIN_POOL_CLASS_PROP_VAL

          @Deprecated
          public static final String USER_DOMAIN_POOL_CLASS_PROP_VAL

      Deprecated. moved to RepositoryFactory
      Field description
      See Also:
        Constant Field Values

  - ### Constructor Detail

    - #### ConfiguratorAbstract

          public ConfiguratorAbstract()

  - ### Method Detail

    - #### componentAdded

          public void componentAdded(Configurable component)

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

    - #### componentRemoved

          public void componentRemoved(Configurable component)

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

    - #### init

          public void init(String[] args)
                    throws ConfigurationException,
                           TigaseDBException

      Method description
      Parameters:
        `args` -
      Throws:
        `ConfigurationException`
        `TigaseDBException`

    - #### initBindings

          public void initBindings(Bindings binds)

      Initialize a mapping of key/value pairs which can be used in scripts loaded by the server
      Overrides:
        `initBindings` in class `BasicComponent`
      Parameters:
        `binds` - A mapping of key/value pairs, all of whose keys are Strings.

    - #### initializationCompleted

          public void initializationCompleted()

      Method description
      Specified by:
        `initializationCompleted` in interface `ServerComponent`
      Overrides:
        `initializationCompleted` in class `BasicComponent`

    - #### itemAdded

          public void itemAdded(ConfigItem item)

      Method description
      Specified by:
        `itemAdded` in interface `RepositoryChangeListenerIfc<ConfigItem>`
      Parameters:
        `item` -

    - #### itemRemoved

          public void itemRemoved(ConfigItem item)

      Method description
      Specified by:
        `itemRemoved` in interface `RepositoryChangeListenerIfc<ConfigItem>`
      Parameters:
        `item` -

    - #### itemUpdated

          public void itemUpdated(ConfigItem item)

      Method description
      Specified by:
        `itemUpdated` in interface `RepositoryChangeListenerIfc<ConfigItem>`
      Parameters:
        `item` -

    - #### loadLogManagerConfig

          public static void loadLogManagerConfig(String config)

      Method description
      Parameters:
        `config` -

    - #### parseArgs

          public void parseArgs(String[] args)

      Method description
      Parameters:
        `args` -

    - #### putMXBean

          public static void putMXBean(String objName,
                       Object bean)

      Method description
      Parameters:
        `objName` -
        `bean` -

    - #### putProperties

          public void putProperties(String compId,
                           Map<String,Object> props)
                             throws ConfigurationException

      Method description
      Parameters:
        `compId` -
        `props` -
      Throws:
        `ConfigurationException`

    - #### setup

          public void setup(Configurable component)

      Method description
      Parameters:
        `component` -

    - #### getDefaults

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

      Returns default configuration settings in case if there is no configuration file.
      Specified by:
        `getDefaults` in interface `Configurable`
      Overrides:
        `getDefaults` in class `BasicComponent`
      Parameters:
        `params` -
      Returns:
        a value of `Map`

    - #### getDefConfigParams

          public Map<String,Object> getDefConfigParams()

      Method description

    - #### getMessageRouterClassName

          public String getMessageRouterClassName()

      Method description

    - #### getMXBean

          public static Object getMXBean(String objName)

      Method description
      Parameters:
        `objName` -

    - #### getProperties

          public Map<String,Object> getProperties(String nodeId)
                                           throws ConfigurationException

      Method description
      Parameters:
        `nodeId` -
      Throws:
        `ConfigurationException`

    - #### isCorrectType

          public boolean isCorrectType(ServerComponent component)

      Method description
      Specified by:
        `isCorrectType` in class `AbstractComponentRegistrator<Configurable>`
      Parameters:
        `component` -
      Returns:
        a `boolean` value of `true` if the component is of a correct type and `false` otherwise.

    - #### setProperties

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

      Sets all configuration properties for object.
      Specified by:
        `setProperties` in interface `Configurable`
      Overrides:
        `setProperties` in class `BasicComponent`
      Parameters:
        `props` -

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