org.ehcache.xml

Class XmlConfiguration

java.lang.Object

org.ehcache.xml.XmlConfiguration

All Implemented Interfaces:

Configuration

public class XmlConfiguration
extends java.lang.Object
implements Configuration

Exposes Configuration and CacheConfigurationBuilder expressed in a XML file that obeys the core Ehcache schema.

Instances of this class are not thread-safe.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	XmlConfiguration.Template

Field Summary

Fields

Modifier and Type	Field and Description
static java.net.URL	CORE_SCHEMA_URL

Constructor Summary

Constructors

Constructor and Description
XmlConfiguration(Configuration configuration) Constructs an instance of XmlConfiguration from an existing configuration object.
XmlConfiguration(org.w3c.dom.Document xml) Constructs an instance of XmlConfiguration from the given XML DOM.
XmlConfiguration(org.w3c.dom.Document xml, java.lang.ClassLoader classLoader) Constructs an instance of XmlConfiguration from the given XML DOM and using the provided classLoader to load user types (e.g.
XmlConfiguration(org.w3c.dom.Document xml, java.lang.ClassLoader classLoader, java.util.Map<java.lang.String,java.lang.ClassLoader> cacheClassLoaders) Constructs an instance of XmlConfiguration from the given XML DOM and using the provided classLoader to load user types (e.g.
XmlConfiguration(java.net.URL url) Constructs an instance of XmlConfiguration mapping to the XML file located at url.
XmlConfiguration(java.net.URL url, java.lang.ClassLoader classLoader) Constructs an instance of XmlConfiguration mapping to the XML file located at url and using the provided classLoader to load user types (e.g.
XmlConfiguration(java.net.URL url, java.lang.ClassLoader classLoader, java.util.Map<java.lang.String,java.lang.ClassLoader> cacheClassLoaders) Constructs an instance of XmlConfiguration mapping to the XML file located at url and using the provided classLoader to load user types (e.g.

Method Summary

Modifier and Type	Method and Description
org.w3c.dom.Document	asDocument() Return this configuration as an XML Document.
java.lang.String	asRenderedDocument() Return this configuration as a rendered XML string.
FluentConfigurationBuilder<?>	derive() Creates a builder seeded with this configuration.
java.util.Map<java.lang.String,CacheConfiguration<?,?>>	getCacheConfigurations() Mapping of aliases to CacheConfigurations, used to configure the Caches managed by the CacheManager.
static java.lang.Class<?>	getClassForName(java.lang.String name, java.lang.ClassLoader classLoader)
java.lang.ClassLoader	getClassLoader() The ClassLoader for the CacheManager.
java.util.Collection<ServiceCreationConfiguration<?,?>>	getServiceCreationConfigurations() ServiceCreationConfiguration initially used to bootstrap the CacheManager and its Caches.
java.net.URL	getURL() Exposes the URL where the XML file parsed or yet to be parsed was or will be sourced from.
<K,V> CacheConfigurationBuilder<K,V>	newCacheConfigurationBuilderFromTemplate(java.lang.String name, java.lang.Class<K> keyType, java.lang.Class<V> valueType) Creates a new CacheConfigurationBuilder seeded with the cache-template configuration by the given name in the parsed XML configuration.
<K,V> CacheConfigurationBuilder<K,V>	newCacheConfigurationBuilderFromTemplate(java.lang.String name, java.lang.Class<K> keyType, java.lang.Class<V> valueType, Builder<? extends ResourcePools> resourcePoolsBuilder) Creates a new CacheConfigurationBuilder seeded with the cache-template configuration by the given name in the parsed XML configuration.
<K,V> CacheConfigurationBuilder<K,V>	newCacheConfigurationBuilderFromTemplate(java.lang.String name, java.lang.Class<K> keyType, java.lang.Class<V> valueType, ResourcePools resourcePools) Creates a new CacheConfigurationBuilder seeded with the cache-template configuration by the given name in the parsed XML configuration.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

CORE_SCHEMA_URL

public static final java.net.URL CORE_SCHEMA_URL

Constructor Detail

XmlConfiguration

public XmlConfiguration(java.net.URL url)
                 throws org.ehcache.xml.exceptions.XmlConfigurationException

Constructs an instance of XmlConfiguration mapping to the XML file located at url.

The default ClassLoader will first try to use the thread context class loader, followed by the ClassLoader that loaded the Ehcache classes.

Parameters:

url - URL pointing to the XML file's location

Throws:

org.ehcache.xml.exceptions.XmlConfigurationException - if anything went wrong parsing the XML

XmlConfiguration

public XmlConfiguration(java.net.URL url,
                        java.lang.ClassLoader classLoader)
                 throws org.ehcache.xml.exceptions.XmlConfigurationException

Constructs an instance of XmlConfiguration mapping to the XML file located at url and using the provided classLoader to load user types (e.g. key and value Class instances).

Parameters:

url - URL pointing to the XML file's location

classLoader - ClassLoader to use to load user types.

Throws:

org.ehcache.xml.exceptions.XmlConfigurationException - if anything went wrong parsing the XML

XmlConfiguration

public XmlConfiguration(java.net.URL url,
                        java.lang.ClassLoader classLoader,
                        java.util.Map<java.lang.String,java.lang.ClassLoader> cacheClassLoaders)
                 throws org.ehcache.xml.exceptions.XmlConfigurationException

Constructs an instance of XmlConfiguration mapping to the XML file located at url and using the provided classLoader to load user types (e.g. key and value Class instances). The cacheClassLoaders will let you specify a different ClassLoader to use for each Cache managed by the CacheManager configured using this XmlConfiguration. Caches with aliases that do not appear in the map will use classLoader as a default.

Parameters:

url - URL pointing to the XML file's location

classLoader - ClassLoader to use to load user types.

cacheClassLoaders - the map with mappings between cache names and the corresponding class loaders

Throws:

org.ehcache.xml.exceptions.XmlConfigurationException - if anything went wrong parsing the XML

XmlConfiguration

public XmlConfiguration(org.w3c.dom.Document xml)
                 throws org.ehcache.xml.exceptions.XmlConfigurationException

Constructs an instance of XmlConfiguration from the given XML DOM.

The default ClassLoader will first try to use the thread context class loader, followed by the ClassLoader that loaded the Ehcache classes.

Parameters:

xml - XML Document Object Model

Throws:

org.ehcache.xml.exceptions.XmlConfigurationException - if anything went wrong parsing the XML

XmlConfiguration

public XmlConfiguration(org.w3c.dom.Document xml,
                        java.lang.ClassLoader classLoader)
                 throws org.ehcache.xml.exceptions.XmlConfigurationException

Constructs an instance of XmlConfiguration from the given XML DOM and using the provided classLoader to load user types (e.g. key and value Class instances).

Parameters:

xml - XML Document Object Model

classLoader - ClassLoader to use to load user types.

Throws:

org.ehcache.xml.exceptions.XmlConfigurationException - if anything went wrong parsing the XML

XmlConfiguration

public XmlConfiguration(org.w3c.dom.Document xml,
                        java.lang.ClassLoader classLoader,
                        java.util.Map<java.lang.String,java.lang.ClassLoader> cacheClassLoaders)
                 throws org.ehcache.xml.exceptions.XmlConfigurationException

Constructs an instance of XmlConfiguration from the given XML DOM and using the provided classLoader to load user types (e.g. key and value Class instances). The cacheClassLoaders will let you specify a different ClassLoader to use for each Cache managed by the CacheManager configured using this XmlConfiguration. Caches with aliases that do not appear in the map will use classLoader as a default.

Parameters:

xml - XML Document Object Model

classLoader - ClassLoader to use to load user types.

cacheClassLoaders - the map with mappings between cache names and the corresponding class loaders

Throws:

org.ehcache.xml.exceptions.XmlConfigurationException - if anything went wrong parsing the XML

XmlConfiguration

public XmlConfiguration(Configuration configuration)
                 throws org.ehcache.xml.exceptions.XmlConfigurationException

Constructs an instance of XmlConfiguration from an existing configuration object.

Parameters:

configuration - existing configuration

Throws:

org.ehcache.xml.exceptions.XmlConfigurationException - if anything went wrong converting to XML

Method Detail

asDocument

public org.w3c.dom.Document asDocument()

Return this configuration as an XML Document.

Returns:

configuration XML DOM.

asRenderedDocument

public java.lang.String asRenderedDocument()

Return this configuration as a rendered XML string.

Returns:

configuration XML string

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

getURL

public java.net.URL getURL()

Exposes the URL where the XML file parsed or yet to be parsed was or will be sourced from.

Returns:

The URL provided at object instantiation

newCacheConfigurationBuilderFromTemplate

public <K,V> CacheConfigurationBuilder<K,V> newCacheConfigurationBuilderFromTemplate(java.lang.String name,
                                                                                     java.lang.Class<K> keyType,
                                                                                     java.lang.Class<V> valueType)
                                                                              throws java.lang.InstantiationException,
                                                                                     java.lang.IllegalAccessException,
                                                                                     java.lang.ClassNotFoundException

Creates a new CacheConfigurationBuilder seeded with the cache-template configuration by the given name in the parsed XML configuration.

Note that this version does not specify resources, which are mandatory to create a CacheConfigurationBuilder. So if the template does not define resources, this will throw.

Type Parameters:

K - type of keys

V - type of values

Parameters:

name - the unique name identifying the cache-template element in the XML

keyType - the type of keys for the CacheConfigurationBuilder to use, must match the key-type declared in the template if declared in XML

valueType - the type of values for the CacheConfigurationBuilder to use, must match the value-type declared in the template if declared in XML

Returns:

the preconfigured CacheConfigurationBuilder or null if no cache-template for the provided name

Throws:

java.lang.IllegalStateException - if the template does not configure resources.

java.lang.IllegalArgumentException - if keyType or valueType don't match the declared type(s) of the template

java.lang.ClassNotFoundException - if a Class declared in the XML couldn't be found

java.lang.InstantiationException - if a user provided Class couldn't get instantiated

java.lang.IllegalAccessException - if a method (including constructor) couldn't be invoked on a user provided type

newCacheConfigurationBuilderFromTemplate

public <K,V> CacheConfigurationBuilder<K,V> newCacheConfigurationBuilderFromTemplate(java.lang.String name,
                                                                                     java.lang.Class<K> keyType,
                                                                                     java.lang.Class<V> valueType,
                                                                                     ResourcePools resourcePools)
                                                                              throws java.lang.InstantiationException,
                                                                                     java.lang.IllegalAccessException,
                                                                                     java.lang.ClassNotFoundException

Creates a new CacheConfigurationBuilder seeded with the cache-template configuration by the given name in the parsed XML configuration.

Type Parameters:

K - type of keys

V - type of values

Parameters:

name - the unique name identifying the cache-template element in the XML

keyType - the type of keys for the CacheConfigurationBuilder to use, must match the key-type declared in the template if declared in XML

valueType - the type of values for the CacheConfigurationBuilder to use, must match the value-type declared in the template if declared in XML

resourcePools - Resources definitions that will be used

Returns:

the preconfigured CacheConfigurationBuilder or null if no cache-template for the provided name

Throws:

java.lang.IllegalArgumentException - if keyType or valueType don't match the declared type(s) of the template

java.lang.ClassNotFoundException - if a Class declared in the XML couldn't be found

java.lang.InstantiationException - if a user provided Class couldn't get instantiated

java.lang.IllegalAccessException - if a method (including constructor) couldn't be invoked on a user provided type

newCacheConfigurationBuilderFromTemplate

public <K,V> CacheConfigurationBuilder<K,V> newCacheConfigurationBuilderFromTemplate(java.lang.String name,
                                                                                     java.lang.Class<K> keyType,
                                                                                     java.lang.Class<V> valueType,
                                                                                     Builder<? extends ResourcePools> resourcePoolsBuilder)
                                                                              throws java.lang.InstantiationException,
                                                                                     java.lang.IllegalAccessException,
                                                                                     java.lang.ClassNotFoundException

Creates a new CacheConfigurationBuilder seeded with the cache-template configuration by the given name in the parsed XML configuration.

Type Parameters:

K - type of keys

V - type of values

Parameters:

name - the unique name identifying the cache-template element in the XML

keyType - the type of keys for the CacheConfigurationBuilder to use, must match the key-type declared in the template if declared in XML

valueType - the type of values for the CacheConfigurationBuilder to use, must match the value-type declared in the template if declared in XML

resourcePoolsBuilder - Resources definitions that will be used

Returns:

the preconfigured CacheConfigurationBuilder or null if no cache-template for the provided name

Throws:

java.lang.IllegalArgumentException - if keyType or valueType don't match the declared type(s) of the template

java.lang.ClassNotFoundException - if a Class declared in the XML couldn't be found

java.lang.InstantiationException - if a user provided Class couldn't get instantiated

java.lang.IllegalAccessException - if a method (including constructor) couldn't be invoked on a user provided type

getCacheConfigurations

public java.util.Map<java.lang.String,CacheConfiguration<?,?>> getCacheConfigurations()

Description copied from interface: Configuration

Mapping of aliases to CacheConfigurations, used to configure the Caches managed by the CacheManager.

The map must not be null but can be empty. It must be unmodifiable.

Specified by:

getCacheConfigurations in interface Configuration

Returns:

a map of aliases to cache configurations

getServiceCreationConfigurations

public java.util.Collection<ServiceCreationConfiguration<?,?>> getServiceCreationConfigurations()

Description copied from interface: Configuration

ServiceCreationConfiguration initially used to bootstrap the CacheManager and its Caches.

The collection must not be null but can be empty. Also it must be unmodifiable.

Specified by:

getServiceCreationConfigurations in interface Configuration

Returns:

a collection of service creations configurations

getClassLoader

public java.lang.ClassLoader getClassLoader()

Description copied from interface: Configuration

The ClassLoader for the CacheManager.

This ClassLoader will be used to instantiate cache manager level services and for Caches that do not have a specific ClassLoader.

The ClassLoader must not be null.

Specified by:

getClassLoader in interface Configuration

Returns:

the cache manager ClassLoader

derive

public FluentConfigurationBuilder<?> derive()

Description copied from interface: Configuration

Creates a builder seeded with this configuration.

The default implementation throws UnsupportedOperationException to indicate that configuration derivation is not supported.

Specified by:

derive in interface Configuration

Returns:

a configuration builder

See Also:

FluentConfigurationBuilder

getClassForName

public static java.lang.Class<?> getClassForName(java.lang.String name,
                                                 java.lang.ClassLoader classLoader)
                                          throws java.lang.ClassNotFoundException

Throws:

java.lang.ClassNotFoundException