org.ehcache.config

Interface Configuration

All Known Implementing Classes:

DefaultConfiguration, XmlConfiguration

public interface Configuration

Represents the configuration for a CacheManager.

Implementations are expected to be read-only.

Method Summary

Modifier and Type	Method and Description
default 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.
java.lang.ClassLoader	getClassLoader() The ClassLoader for the CacheManager.
java.util.Collection<ServiceCreationConfiguration<?,?>>	getServiceCreationConfigurations() ServiceCreationConfiguration initially used to bootstrap the CacheManager and its Caches.

Method Detail

getCacheConfigurations

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

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.

Returns:

a map of aliases to cache configurations

getServiceCreationConfigurations

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

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.

Returns:

a collection of service creations configurations

getClassLoader

java.lang.ClassLoader getClassLoader()

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.

Returns:

the cache manager ClassLoader

derive

default FluentConfigurationBuilder<?> derive()

Creates a builder seeded with this configuration.

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

Returns:

a configuration builder

Throws:

java.lang.UnsupportedOperationException - if configuration derivation is not supported

See Also:

FluentConfigurationBuilder