CommonsConfigurationRegistry (Archiva Components :: Spring Registry 3.0-SNAPSHOT API)

java.lang.Object
- org.apache.archiva.components.registry.commons.CommonsConfigurationRegistry

All Implemented Interfaces:

Registry
```
@Service(value="commons-configuration")
public class CommonsConfigurationRegistry
extends Object
implements Registry
```
Implementation of the registry component using Commons Configuration. The use of Commons Configuration enables a variety of sources to be used, including XML files, properties, JNDI, JDBC, etc.
The component can be configured using the properties configuration item, the content of which should take the format of an input to the Commons Configuration configuration builder.

Constructor Summary

Constructors
Constructor and Description

CommonsConfigurationRegistry()

CommonsConfigurationRegistry(org.apache.commons.configuration.Configuration configuration)

Constructors
Constructor and Description
`CommonsConfigurationRegistry()`
`CommonsConfigurationRegistry(org.apache.commons.configuration.Configuration configuration)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addChangeListener(RegistryListener listener)` Add a change listener.
`void`	`addConfigurationFromFile(File file)` Load configuration from the given file.
`void`	`addConfigurationFromFile(File file, String prefix)` Load configuration from the given file.
`void`	`addConfigurationFromResource(String resource)` Load configuration from the given classloader resource.
`void`	`addConfigurationFromResource(String resource, String prefix)` Load configuration from the given classloader resource.
`String`	`dump()` Dump the entire registry to a string, for debugging purposes.
`boolean`	`getBoolean(String key)` Get a boolean value from the registry.
`boolean`	`getBoolean(String key, boolean defaultValue)` Get a boolean value from the registry.
`int`	`getChangeListenersSize()`
`Collection`	`getFullKeys()` Get all the keys in this registry.
`int`	`getInt(String key)` Get an integer value from the registry.
`int`	`getInt(String key, int defaultValue)` Get an integer value from the registry.
`Collection<String>`	`getKeys()` Get all the keys in this registry.
`List`	`getList(String key)` Get a list of strings at the given key in the registry.
`Properties`	`getProperties(String key)` TODO move to Map which is more generic ?
`String`	`getPropertyDelimiter()`
`Registry`	`getSection(String name)` Get a subsection of the registry, identified by the given name.
`String`	`getString(String key)` Get a string value from the registry.
`String`	`getString(String key, String defaultValue)` Get a string value from the registry.
`Registry`	`getSubset(String key)` Get a subset of the registry, for all keys descended from the given key.
`List<Registry>`	`getSubsetList(String key)` Get a list of subsets of the registry, for all keys descended from the given key.
`void`	`initialize()`
`boolean`	`isEmpty()` Determine if the registry contains any elements.
`void`	`remove(String key)` Remove a keyed element from the registry.
`boolean`	`removeChangeListener(RegistryListener listener)`
`void`	`removeSubset(String key)` Remove a keyed subset of the registry.
`void`	`save()` Save any changes to the registry since it was loaded.
`void`	`setBoolean(String key, boolean value)` Set a boolean value in the registry.
`void`	`setInt(String key, int value)` Set an integer value in the registry.
`void`	`setProperties(String properties)`
`void`	`setPropertyDelimiter(String propertyDelimiter)`
`void`	`setString(String key, String value)` Set a string value in the registry.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - CommonsConfigurationRegistry
```
public CommonsConfigurationRegistry()
```
  - CommonsConfigurationRegistry
```
public CommonsConfigurationRegistry(org.apache.commons.configuration.Configuration configuration)
```
- Method Detail
  - dump
```
public String dump()
```
    Description copied from interface: Registry
    
    Dump the entire registry to a string, for debugging purposes.
    
    Specified by:
    
    dump in interface Registry
    
    Returns:
    
    the registry contents
  - isEmpty
```
public boolean isEmpty()
```
    Description copied from interface: Registry
    
    Determine if the registry contains any elements.
    
    Specified by:
    
    isEmpty in interface Registry
    
    Returns:
    
    whether the registry contains any elements
  - getSubset
```
public Registry getSubset(String key)
```
    Description copied from interface: Registry
    
    Get a subset of the registry, for all keys descended from the given key.
    
    Specified by:
    
    getSubset in interface Registry
    
    Parameters:
    
    key - the key to take the subset from
    
    Returns:
    
    the registry subset
  - getList
```
public List getList(String key)
```
    Description copied from interface: Registry
    
    Get a list of strings at the given key in the registry.
    
    Specified by:
    
    getList in interface Registry
    
    Parameters:
    
    key - the key to lookup
    
    Returns:
    
    the list of strings
  - getSubsetList
```
public List<Registry> getSubsetList(String key)
```
    Description copied from interface: Registry
    
    Get a list of subsets of the registry, for all keys descended from the given key.
    
    Specified by:
    
    getSubsetList in interface Registry
    
    Parameters:
    
    key - the key to take the subsets from
    
    Returns:
    
    the registry subsets
  - getProperties
```
public Properties getProperties(String key)
```
    Description copied from interface: Registry
    
    TODO move to Map which is more generic ? Get the properties at the given key in the registry.
    
    Specified by:
    
    getProperties in interface Registry
    
    Parameters:
    
    key - the key to lookup
    
    Returns:
    
    the properties
  - save
```
public void save()
          throws RegistryException
```
    Description copied from interface: Registry
    
    Save any changes to the registry since it was loaded.
    
    Specified by:
    
    save in interface Registry
    
    Throws:
    
    RegistryException - if there was a problem saving the registry
  - addChangeListener
```
public void addChangeListener(RegistryListener listener)
```
    Description copied from interface: Registry
    
    Add a change listener. Note that settings this on the base registry will only detect 'invalidation' events, not individual changes. You should retrieve the named sub-registry to listen for changes. TODO: this isn't ideal, so maybe fix combined configuration to re-fire it's events to it's own listeners in the c-c implementation
    
    Specified by:
    
    addChangeListener in interface Registry
    
    Parameters:
    
    listener - the listener
  - removeChangeListener
```
public boolean removeChangeListener(RegistryListener listener)
```
    Specified by:
    
    removeChangeListener in interface Registry
    
    Returns:
    
    true if has been removed
  - getChangeListenersSize
```
public int getChangeListenersSize()
```
  - getKeys
```
public Collection<String> getKeys()
```
    Description copied from interface: Registry
    
    Get all the keys in this registry. Keys are only retrieved at a depth of 1.
    
    Specified by:
    
    getKeys in interface Registry
    
    Returns:
    
    the set of keys
  - getFullKeys
```
public Collection getFullKeys()
```
    Description copied from interface: Registry
    
    Get all the keys in this registry.
    
    Specified by:
    
    getFullKeys in interface Registry
    
    Returns:
    
    the set of keys
  - remove
```
public void remove(String key)
```
    Description copied from interface: Registry
    
    Remove a keyed element from the registry.
    
    Specified by:
    
    remove in interface Registry
    
    Parameters:
    
    key - the key to remove
  - removeSubset
```
public void removeSubset(String key)
```
    Description copied from interface: Registry
    
    Remove a keyed subset of the registry.
    
    Specified by:
    
    removeSubset in interface Registry
    
    Parameters:
    
    key - the subset to remove
  - getString
```
public String getString(String key)
```
    Description copied from interface: Registry
    
    Get a string value from the registry. If not found, null is returned.
    
    Specified by:
    
    getString in interface Registry
    
    Parameters:
    
    key - the key in the registry
    
    Returns:
    
    the value
  - getString
```
public String getString(String key,
                        String defaultValue)
```
    Description copied from interface: Registry
    
    Get a string value from the registry. If not found, the default value is used.
    
    Specified by:
    
    getString in interface Registry
    
    Parameters:
    
    key - the key in the registry
    
    defaultValue - the default value
    
    Returns:
    
    the value
  - setString
```
public void setString(String key,
                      String value)
```
    Description copied from interface: Registry
    
    Set a string value in the registry.
    
    Specified by:
    
    setString in interface Registry
    
    Parameters:
    
    key - the key in the registry
    
    value - the value to set
  - getInt
```
public int getInt(String key)
```
    Description copied from interface: Registry
    
    Get an integer value from the registry. If not found, an exception is thrown.
    
    Specified by:
    
    getInt in interface Registry
    
    Parameters:
    
    key - the key in the registry
    
    Returns:
    
    the value
  - getInt
```
public int getInt(String key,
                  int defaultValue)
```
    Description copied from interface: Registry
    
    Get an integer value from the registry. If not found, the default value is used.
    
    Specified by:
    
    getInt in interface Registry
    
    Parameters:
    
    key - the key in the registry
    
    defaultValue - the default value
    
    Returns:
    
    the value
  - setInt
```
public void setInt(String key,
                   int value)
```
    Description copied from interface: Registry
    
    Set an integer value in the registry.
    
    Specified by:
    
    setInt in interface Registry
    
    Parameters:
    
    key - the key in the registry
    
    value - the value to set
  - getBoolean
```
public boolean getBoolean(String key)
```
    Description copied from interface: Registry
    
    Get a boolean value from the registry. If not found, an exception is thrown.
    
    Specified by:
    
    getBoolean in interface Registry
    
    Parameters:
    
    key - the key in the registry
    
    Returns:
    
    the value
  - getBoolean
```
public boolean getBoolean(String key,
                          boolean defaultValue)
```
    Description copied from interface: Registry
    
    Get a boolean value from the registry. If not found, the default value is used.
    
    Specified by:
    
    getBoolean in interface Registry
    
    Parameters:
    
    key - the key in the registry
    
    defaultValue - the default value
    
    Returns:
    
    the value
  - setBoolean
```
public void setBoolean(String key,
                       boolean value)
```
    Description copied from interface: Registry
    
    Set a boolean value in the registry.
    
    Specified by:
    
    setBoolean in interface Registry
    
    Parameters:
    
    key - the key in the registry
    
    value - the value to set
  - addConfigurationFromResource
```
public void addConfigurationFromResource(String resource)
                                  throws RegistryException
```
    Description copied from interface: Registry
    
    Load configuration from the given classloader resource.
    
    Specified by:
    
    addConfigurationFromResource in interface Registry
    
    Parameters:
    
    resource - the location to load the configuration from
    
    Throws:
    
    RegistryException - if a problem occurred reading the resource to add to the registry
  - addConfigurationFromResource
```
public void addConfigurationFromResource(String resource,
                                         String prefix)
                                  throws RegistryException
```
    Description copied from interface: Registry
    
    Load configuration from the given classloader resource.
    
    Specified by:
    
    addConfigurationFromResource in interface Registry
    
    Parameters:
    
    resource - the location to load the configuration from
    
    prefix - the location to add the configuration at in the registry
    
    Throws:
    
    RegistryException - if a problem occurred reading the resource to add to the registry
  - addConfigurationFromFile
```
public void addConfigurationFromFile(File file)
                              throws RegistryException
```
    Description copied from interface: Registry
    
    Load configuration from the given file.
    
    Specified by:
    
    addConfigurationFromFile in interface Registry
    
    Parameters:
    
    file - the location to load the configuration from
    
    Throws:
    
    RegistryException - if a problem occurred reading the resource to add to the registry
  - addConfigurationFromFile
```
public void addConfigurationFromFile(File file,
                                     String prefix)
                              throws RegistryException
```
    Description copied from interface: Registry
    
    Load configuration from the given file.
    
    Specified by:
    
    addConfigurationFromFile in interface Registry
    
    Parameters:
    
    file - the location to load the configuration from
    
    prefix - the location to add the configuration at in the registry
    
    Throws:
    
    RegistryException - if a problem occurred reading the resource to add to the registry
  - initialize
```
@PostConstruct
public void initialize()
                               throws RegistryException
```
    Specified by:
    
    initialize in interface Registry
    
    Throws:
    
    RegistryException
  - setProperties
```
public void setProperties(String properties)
```
  - getSection
```
public Registry getSection(String name)
```
    Description copied from interface: Registry
    
    Get a subsection of the registry, identified by the given name. If it doesn't exist, null will be returned.
    
    Specified by:
    
    getSection in interface Registry
    
    Parameters:
    
    name - registry section name
    
    Returns:
    
    the registry
  - getPropertyDelimiter
```
public String getPropertyDelimiter()
```
  - setPropertyDelimiter
```
public void setPropertyDelimiter(String propertyDelimiter)
```

Class CommonsConfigurationRegistry

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

CommonsConfigurationRegistry

CommonsConfigurationRegistry

Method Detail

dump

isEmpty

getSubset

getList

getSubsetList

getProperties

save

addChangeListener

removeChangeListener

getChangeListenersSize

getKeys

getFullKeys

remove

removeSubset

getString

getString

setString

getInt

getInt

setInt

getBoolean

getBoolean

setBoolean

addConfigurationFromResource

addConfigurationFromResource

addConfigurationFromFile

addConfigurationFromFile

initialize

setProperties

getSection

getPropertyDelimiter

setPropertyDelimiter