org.jboss.cache.config
Interface ConfigurationRegistry

All Known Implementing Classes:

XmlParsingConfigurationRegistry

public interface ConfigurationRegistry

A registry for Configurations.

Version:

$Revision: 7168 $

Author:

Brian Stansberry

Method Summary

Configuration	getConfiguration(java.lang.String configName) Gets a clone of the Configuration registered under the given name.
java.util.Set<java.lang.String>	getConfigurationNames() Gets the names of all registered configurations.
void	registerConfiguration(java.lang.String configName, Configuration config) Register the given configuration under the given name.
void	unregisterConfiguration(java.lang.String configName) Unregisters the named configuration.

Method Detail

getConfiguration

Configuration getConfiguration(java.lang.String configName)
                               throws java.lang.Exception

Gets a clone of the Configuration registered under the given name.

The returned object is a clone of the internally held configuration, so any changes made to it by the caller will not affect the internal state of this registry.

Parameters:

configName - the name of the configuration

Returns:

a Configuration. Will not be null.

Throws:

java.lang.IllegalArgumentException - if no configuration is registered under configName

java.lang.Exception

registerConfiguration

void registerConfiguration(java.lang.String configName,
                           Configuration config)
                           throws java.lang.CloneNotSupportedException

Register the given configuration under the given name.

The configuration will be cloned before being stored internally, so the copy under the control of the registry will not be affected by any external changes.

Parameters:

configName - the name of the configuration

config - the configuration

Throws:

java.lang.CloneNotSupportedException

java.lang.IllegalStateException - if a configuration is already registered under configName

unregisterConfiguration

void unregisterConfiguration(java.lang.String configName)

Unregisters the named configuration.

Parameters:

configName - the name of the configuration

Throws:

java.lang.IllegalStateException - if no configuration is registered under configName

getConfigurationNames

java.util.Set<java.lang.String> getConfigurationNames()

Gets the names of all registered configurations.

Returns:

a set of configuration names