tigase.conf
Interface ConfigRepositoryIfc

All Superinterfaces:
ComponentRepository<ConfigItem>, Iterable<ConfigItem>
All Known Implementing Classes:
ConfigSQLRepository, ConfigurationCache, ConfigXMLRepository

public interface ConfigRepositoryIfc
extends ComponentRepository<ConfigItem>

Created: Dec 10, 2009 2:04:20 PM

Version:
$Rev: 1991 $
Author:
Artur Hefczyc

Field Summary
static String RELOAD_DELAY
           
static String RESOURCE_URI
           
 
Fields inherited from interface tigase.db.ComponentRepository
COMP_REPO_BIND
 
Method Summary
 void addItem(String key, Object value)
          Method adds an Item to the configuration repository where the key is the item key constructed of component name, node name and property key name.
 Object get(String compName, String node, String key, Object def)
          Returns a configuration setting for a given component, node and key.
 String[] getCompNames()
          Returns all component names for which there are some configuration settings available.
 Map<String,Object> getInitProperties()
           
 String[] getKeys(String compName, String node)
          Returns an array of all configuration keys for a given component and configuration node.
 Map<String,Object> getProperties(String compName)
          Returns all known settings for the given component name.
 void init(Map<String,Object> params)
          Initializes the configuration repository.
 void putProperties(String compName, Map<String,Object> props)
          Sets/adds properties for the given component name.
 void remove(String compName, String node, String key)
          Removes a configuration setting from the configuration repository.
 void set(String compName, String node, String key, Object value)
          Puts/sets/adds/updates a configuration setting to the configuration repository.
 void setDefHostname(String hostname)
          This is used to load a configuration for a selected cluster node.
 
Methods inherited from interface tigase.db.ComponentRepository
addItem, allItems, contains, getDefaults, getItem, getItemInstance, reload, removeItem, setProperties, size, store
 
Methods inherited from interface java.lang.Iterable
iterator
 

Field Detail

RESOURCE_URI

static final String RESOURCE_URI
See Also:
Constant Field Values

RELOAD_DELAY

static final String RELOAD_DELAY
See Also:
Constant Field Values
Method Detail

init

void init(Map<String,Object> params)
          throws ConfigurationException
Initializes the configuration repository.

Parameters:
params -
Throws:
ConfigurationException

getProperties

Map<String,Object> getProperties(String compName)
                                 throws ConfigurationException
Returns all known settings for the given component name.

Parameters:
compName -
Returns:
Throws:
ConfigurationException

putProperties

void putProperties(String compName,
                   Map<String,Object> props)
                   throws ConfigurationException
Sets/adds properties for the given component name.

Parameters:
compName -
props -
Throws:
ConfigurationException

get

Object get(String compName,
           String node,
           String key,
           Object def)
Returns a configuration setting for a given component, node and key. If the configuration parameters is not found, returns given default value.

Parameters:
compName -
node -
key -
def -
Returns:

set

void set(String compName,
         String node,
         String key,
         Object value)
Puts/sets/adds/updates a configuration setting to the configuration repository.

Parameters:
compName -
node -
key -
value -

getCompNames

String[] getCompNames()
Returns all component names for which there are some configuration settings available.

Returns:

getKeys

String[] getKeys(String compName,
                 String node)
Returns an array of all configuration keys for a given component and configuration node.

Parameters:
compName -
node -
Returns:

remove

void remove(String compName,
            String node,
            String key)
Removes a configuration setting from the configuration repository.

Parameters:
compName -
node -
key -

addItem

void addItem(String key,
             Object value)
             throws ConfigurationException
Method adds an Item to the configuration repository where the key is the item key constructed of component name, node name and property key name.

Parameters:
key -
value -
Throws:
ConfigurationException

setDefHostname

void setDefHostname(String hostname)
This is used to load a configuration for a selected cluster node. The configuration repository (file or database) may contain settings for all cluster nodes, some of the settings may be exclusive to one or another cluster node. This method informs the repository what node name (hostname) it is running on.

Parameters:
hostname -

getInitProperties

Map<String,Object> getInitProperties()


Copyright © 2001-2006 Tigase Developers Team. All rights Reserved.