org.jboss.cache.config
Class XmlParsingConfigurationRegistry

java.lang.Object
  org.jboss.cache.config.XmlParsingConfigurationRegistry

All Implemented Interfaces:

ConfigurationRegistry

public class XmlParsingConfigurationRegistry
extends java.lang.Object
implements ConfigurationRegistry

ConfigurationRegistry that obtains its initial set of configurations by parsing an XML document.

Version:

$Revision: 7168 $

Author:

Brian Stansberry

Constructor Summary

XmlParsingConfigurationRegistry(java.lang.String configResource)

Method Summary

java.lang.String	getConfigResource()
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	start()
void	stop()
void	unregisterConfiguration(java.lang.String configName) Unregisters the named configuration.

Methods inherited from class java.lang.Object

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

Constructor Detail

XmlParsingConfigurationRegistry

public XmlParsingConfigurationRegistry(java.lang.String configResource)

Method Detail

start

public void start()
           throws java.lang.Exception

Throws:

java.lang.Exception

stop

public void stop()

getConfigResource

public java.lang.String getConfigResource()

getConfigurationNames

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

Description copied from interface: ConfigurationRegistry

Gets the names of all registered configurations.

Specified by:

getConfigurationNames in interface ConfigurationRegistry

Returns:

a set of configuration names

registerConfiguration

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

Description copied from interface: ConfigurationRegistry

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.

Specified by:

registerConfiguration in interface ConfigurationRegistry

Parameters:

configName - the name of the configuration

config - the configuration

Throws:

java.lang.CloneNotSupportedException

unregisterConfiguration

public void unregisterConfiguration(java.lang.String configName)

Description copied from interface: ConfigurationRegistry

Unregisters the named configuration.

Specified by:

unregisterConfiguration in interface ConfigurationRegistry

Parameters:

configName - the name of the configuration

getConfiguration

public Configuration getConfiguration(java.lang.String configName)

Description copied from interface: ConfigurationRegistry

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.

Specified by:

getConfiguration in interface ConfigurationRegistry

Parameters:

configName - the name of the configuration

Returns:

a Configuration. Will not be null.