Package org.ehcache.config

Interface Configuration

public interface Configuration
Represents the configuration for a CacheManager.

Implementations are expected to be read-only.

  • Method Details

    • getCacheConfigurations

      Map<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

      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

      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

    • getSharedResourcePools

      ResourcePools getSharedResourcePools()
      Returns a mapping of ResourceTypes to ResourcePools, for all configured shared resource pools
      Returns:
      a map of ResourceTypes to shared ResourcePools

    • 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:
      UnsupportedOperationException - if configuration derivation is not supported
      See Also: