net.sf.ehcache.config
Class Configuration

java.lang.Object
  net.sf.ehcache.config.Configuration

public final class Configuration
extends Object

A bean, used by BeanUtils, to set configuration from an XML configuration file.

Version:

$Id: Configuration.java 10095 2015-10-16 17:20:30Z ljacomet $

Author:

Greg Luck

Nested Class Summary

static class	Configuration.Monitoring Represents whether monitoring should be enabled or not.
class	Configuration.RuntimeCfg Runtime configuration as being used by the CacheManager

Field Summary

static boolean	DEFAULT_DYNAMIC_CONFIG Default value for dynamicConfig
static long	DEFAULT_MAX_BYTES_OFF_HEAP Default value for maxBytesLocalOffHeap when not explicitly set
static long	DEFAULT_MAX_BYTES_ON_DISK Default value for maxBytesLocalDisk when not explicitly set
static long	DEFAULT_MAX_BYTES_ON_HEAP Default value for maxBytesLocalHeap when not explicitly set
static Configuration.Monitoring	DEFAULT_MONITORING Default value for monitoring
static SizeOfPolicyConfiguration	DEFAULT_SIZEOF_POLICY_CONFIGURATION Default sizeOfPolicy configuration
static FactoryConfiguration	DEFAULT_TRANSACTION_MANAGER_LOOKUP_CONFIG Default transactionManagerLookupConfiguration
static int	DEFAULT_TRANSACTION_TIMEOUT Default value for defaultTransactionTimeoutInSeconds
static boolean	DEFAULT_UPDATE_CHECK Default value for updateCheck

Constructor Summary

Configuration()
Empty constructor, which is used by ConfigurationFactory, and can be also used programmatically.

Method Summary

void	addCache(CacheConfiguration cacheConfiguration) Allows BeanHandler to add Cache Configurations to the configuration.
void	addCacheManagerEventListenerFactory(FactoryConfiguration cacheManagerEventListenerFactoryConfiguration) Allows BeanHandler to add the CacheManagerEventListener to the configuration.
void	addCacheManagerPeerListenerFactory(FactoryConfiguration factory) Adds a CacheManagerPeerListener through FactoryConfiguration.
void	addCacheManagerPeerProviderFactory(FactoryConfiguration factory) Adds a CacheManagerPeerProvider through FactoryConfiguration.
void	addDefaultCache(CacheConfiguration defaultCacheConfiguration) Allows BeanHandler to add a default configuration to the configuration.
void	addDiskStore(DiskStoreConfiguration diskStoreConfigurationParameter) Allows BeanHandler to add disk store location to the configuration.
void	addManagementRESTService(ManagementRESTServiceConfiguration managementRESTServiceConfiguration) Allows BeanHandler to add a ManagementRESTService configuration to the configuration
boolean	addPropertyChangeListener(PropertyChangeListener listener) Adds a PropertyChangeListener for this configuration
void	addSizeOfPolicy(SizeOfPolicyConfiguration sizeOfPolicy) Sets the default SizeOfPolicyConfiguration for this cache manager.
void	addTerracottaConfig(TerracottaClientConfiguration terracottaConfiguration) Allows BeanHandler to add a Terracotta configuration to the configuration
void	addTransactionManagerLookup(FactoryConfiguration transactionManagerLookupParameter) Allows BeanHandler to add transaction manager lookup to the configuration.
Configuration	cache(CacheConfiguration cacheConfiguration) Builder to add a new cache through its config
Configuration	cacheManagerEventListenerFactory(FactoryConfiguration cacheManagerEventListenerFactoryConfiguration) Builder to set the event lister through a factory, only one of these can be added and subsequent calls are ignored.
Configuration	cacheManagerPeerListenerFactory(FactoryConfiguration factory) Builder method to add a peer listener through a factory.
Configuration	cacheManagerPeerProviderFactory(FactoryConfiguration factory) Builder method to add a peer provider through a factory.
void	cleanup()
Configuration	defaultCache(CacheConfiguration defaultCacheConfiguration) Builder method to set the default cache configuration, this can only be used once.
Configuration	defaultTransactionTimeoutInSeconds(int defaultTransactionTimeoutInSeconds) Builder to set the default transaction timeout.
Configuration	diskStore(DiskStoreConfiguration diskStoreConfigurationParameter) Builder to add a disk store to the cache manager, only one disk store can be added.
Configuration	dynamicConfig(boolean dynamicConfig) Builder to set the dynamic config capability
Map<String,CacheConfiguration>	getCacheConfigurations() Gets a Map of cache configurations, keyed by name.
Set<String>	getCacheConfigurationsKeySet() Gets a Map of cacheConfigurations.
FactoryConfiguration	getCacheManagerEventListenerFactoryConfiguration() Gets the CacheManagerEventListener factory configuration.
List<FactoryConfiguration>	getCacheManagerPeerListenerFactoryConfigurations() Gets the CacheManagerPeerListener factory configuration.
List<FactoryConfiguration>	getCacheManagerPeerProviderFactoryConfiguration() Gets the CacheManagerPeerProvider factory configuration.
ClassLoader	getClassLoader()
ConfigurationSource	getConfigurationSource() Gets a description of the source from which this configuration was created.
CacheConfiguration	getDefaultCacheConfiguration()
int	getDefaultTransactionTimeoutInSeconds() Get default transaction timeout
DiskStoreConfiguration	getDiskStoreConfiguration() Gets the disk store configuration.
boolean	getDynamicConfig() Get flag for dynamicConfig
ManagementRESTServiceConfiguration	getManagementRESTService() Gets the ManagementRESTServiceConfiguration
long	getMaxBytesLocalDisk() Maximum amount of bytes the CacheManager will use on the Disk Tier.
String	getMaxBytesLocalDiskAsString()
long	getMaxBytesLocalHeap() Maximum amount of bytes the CacheManager will use on the heap
String	getMaxBytesLocalHeapAsString()
long	getMaxBytesLocalOffHeap() Maximum amount of bytes the CacheManager will use on the OffHeap Tier.
String	getMaxBytesLocalOffHeapAsString()
Configuration.Monitoring	getMonitoring() Get monitoring type, should not be null
String	getName() CacheManager name
SizeOfPolicyConfiguration	getSizeOfPolicyConfiguration() Gets the SizeOf policy configuration.
TerracottaClientConfiguration	getTerracottaConfiguration() Gets the TerracottaClientConfiguration
long	getTotalConfiguredOffheap()
FactoryConfiguration	getTransactionManagerLookupConfiguration() Gets the transaction manager lookup configuration.
boolean	getUpdateCheck() Get flag for updateCheck
boolean	isMaxBytesLocalDiskSet() Checks whether the user explicitly set the maxBytesOnDisk
boolean	isMaxBytesLocalHeapSet() Checks whether the user explicitly set the maxBytesOnHeap
boolean	isMaxBytesLocalOffHeapSet() Checks whether the user explicitly set the maxBytesOffHeat
Configuration	managementRESTService(ManagementRESTServiceConfiguration cfg) Builder method to REST management capabilities to the cache manager through a dedicated configuration, this can only be used once.
Configuration	maxBytesLocalDisk(long amount, MemoryUnit memoryUnit) Sets the maxOnDisk size
Configuration	maxBytesLocalHeap(long amount, MemoryUnit memoryUnit) Sets the maxOnHeap size for the cache being configured
Configuration	maxBytesLocalOffHeap(long amount, MemoryUnit memoryUnit) Sets the maximum size for the OffHeap tier for all the caches this CacheManagers holds.
Configuration	monitoring(Configuration.Monitoring monitoring) Builder to set the monitoring approach
Configuration	name(String name) Builder to set the cache manager name.
boolean	removePropertyChangeListener(PropertyChangeListener listener) Removes a PropertyChangeListener for this configuration
void	setClassLoader(ClassLoader loader) Set the classloader for the cache manager (and it's associated caches) to use when creating application objects (eg.
void	setDefaultCacheConfiguration(CacheConfiguration defaultCacheConfiguration)
void	setDefaultTransactionTimeoutInSeconds(int defaultTransactionTimeoutInSeconds) Allows BeanHandler to set the default transaction timeout.
void	setDynamicConfig(boolean dynamicConfig) Allows BeanHandler to set the dynamic configuration flag
void	setMaxBytesLocalDisk(Long maxBytesOnDisk) Sets maximum amount of bytes the CacheManager will use on the Disk Tier.
void	setMaxBytesLocalDisk(String maxBytesOnDisk) Sets maximum amount of bytes the CacheManager will use on the Disk Tier.
void	setMaxBytesLocalHeap(Long maxBytesOnHeap) Sets the maximum amount of bytes the cache manager being configured will use on the OnHeap tier
void	setMaxBytesLocalHeap(String maxBytesOnHeap) Sets maximum amount of bytes the CacheManager will use on the Disk Tier.
void	setMaxBytesLocalOffHeap(Long maxBytesOffHeap) Sets maximum amount of bytes the CacheManager will use on the OffHeap Tier.
void	setMaxBytesLocalOffHeap(String maxBytesOffHeap) Sets maximum amount of bytes the CacheManager will use on the OffHeap Tier.
void	setMonitoring(String monitoring) Allows BeanHandler to set the monitoring flag
void	setName(String name) Allows BeanHandler to set the CacheManager name.
void	setSource(ConfigurationSource configurationSource) Sets the configuration source.
void	setUpdateCheck(boolean updateCheck) Allows BeanHandler to set the updateCheck flag.
Configuration.RuntimeCfg	setupFor(CacheManager cacheManager, String fallbackName) Freezes part of the configuration that need to be, and runs validation checks on the Configuration.
Configuration	sizeOfPolicy(SizeOfPolicyConfiguration sizeOfPolicyConfiguration) Builder to set the default SizeOfPolicyConfiguration for this cache manager.
Configuration	source(ConfigurationSource configurationSource) Builder to set the configuration source.
Configuration	terracotta(TerracottaClientConfiguration terracottaConfiguration) Builder method to Terracotta capabilities to the cache manager through a dedicated configuration, this can only be used once.
Configuration	transactionManagerLookup(FactoryConfiguration transactionManagerLookupParameter) Builder to add a transaction manager lookup class to the cache manager, only one of these can be added.
Configuration	updateCheck(boolean updateCheck) Builder to set the state of the automated update check.
Collection<ConfigError>	validate() Validates the current configuration

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_DYNAMIC_CONFIG

public static final boolean DEFAULT_DYNAMIC_CONFIG

Default value for dynamicConfig

See Also:

Constant Field Values

DEFAULT_UPDATE_CHECK

public static final boolean DEFAULT_UPDATE_CHECK

Default value for updateCheck

See Also:

Constant Field Values

DEFAULT_TRANSACTION_TIMEOUT

public static final int DEFAULT_TRANSACTION_TIMEOUT

Default value for defaultTransactionTimeoutInSeconds

See Also:

Constant Field Values

DEFAULT_MAX_BYTES_ON_HEAP

public static final long DEFAULT_MAX_BYTES_ON_HEAP

Default value for maxBytesLocalHeap when not explicitly set

See Also:

Constant Field Values

DEFAULT_MAX_BYTES_OFF_HEAP

public static final long DEFAULT_MAX_BYTES_OFF_HEAP

Default value for maxBytesLocalOffHeap when not explicitly set

See Also:

Constant Field Values

DEFAULT_MAX_BYTES_ON_DISK

public static final long DEFAULT_MAX_BYTES_ON_DISK

Default value for maxBytesLocalDisk when not explicitly set

See Also:

Constant Field Values

DEFAULT_MONITORING

public static final Configuration.Monitoring DEFAULT_MONITORING

Default value for monitoring

DEFAULT_SIZEOF_POLICY_CONFIGURATION

public static final SizeOfPolicyConfiguration DEFAULT_SIZEOF_POLICY_CONFIGURATION

Default sizeOfPolicy configuration

DEFAULT_TRANSACTION_MANAGER_LOOKUP_CONFIG

public static final FactoryConfiguration DEFAULT_TRANSACTION_MANAGER_LOOKUP_CONFIG

Default transactionManagerLookupConfiguration

Constructor Detail

Configuration

public Configuration()

Empty constructor, which is used by ConfigurationFactory, and can be also used programmatically.

If you are using it programmtically you need to call the relevant add and setter methods in this class to populate everything.

Method Detail

setupFor

public Configuration.RuntimeCfg setupFor(CacheManager cacheManager,
                                         String fallbackName)
                                  throws InvalidConfigurationException

Freezes part of the configuration that need to be, and runs validation checks on the Configuration.

Parameters:

cacheManager - the CacheManager instance being configured

Throws:

InvalidConfigurationException - With all the associated errors

validate

public Collection<ConfigError> validate()

Validates the current configuration

Returns:

the list of errors withing that configuration

isMaxBytesLocalDiskSet

public boolean isMaxBytesLocalDiskSet()

Checks whether the user explicitly set the maxBytesOnDisk

Returns:

true if set by user, false otherwise

See Also:

setMaxBytesLocalDisk(Long)

isMaxBytesLocalOffHeapSet

public boolean isMaxBytesLocalOffHeapSet()

Checks whether the user explicitly set the maxBytesOffHeat

Returns:

true if set by user, false otherwise

See Also:

setMaxBytesLocalOffHeap(Long)

isMaxBytesLocalHeapSet

public boolean isMaxBytesLocalHeapSet()

Checks whether the user explicitly set the maxBytesOnHeap

Returns:

true if set by user, false otherwise

See Also:

setMaxBytesLocalHeap(Long)

name

public final Configuration name(String name)

Builder to set the cache manager name.

Cache manager names have constraints on the characters they can use:

• cache managers that are registered as MBeans must obey the ObjectName rules for unquoted value. This means the following characters are illegal: ',', '=', ':', '"', '*' and '?'.

Note that a clustered cache manager is by default registered as MBean.

Parameters:

name - the name to set

Returns:

this configuration instance

See Also:

setName(String)

setName

public final void setName(String name)

Allows BeanHandler to set the CacheManager name.

Cache manager names have constraints on the characters they can use:

• cache managers that are registered as MBeans must obey the ObjectName rules for unquoted value. This means the following characters are illegal: ',', '=', ':', '"', '*' and '?'.

Note that a clustered cache manager is by default registered as MBean.

getName

public final String getName()

CacheManager name

updateCheck

public final Configuration updateCheck(boolean updateCheck)

Builder to set the state of the automated update check.

Parameters:

updateCheck - true if the update check should be turned on; or false otherwise

Returns:

this configuration instance

setUpdateCheck

public final void setUpdateCheck(boolean updateCheck)

Allows BeanHandler to set the updateCheck flag.

getUpdateCheck

public final boolean getUpdateCheck()

Get flag for updateCheck

defaultTransactionTimeoutInSeconds

public final Configuration defaultTransactionTimeoutInSeconds(int defaultTransactionTimeoutInSeconds)

Builder to set the default transaction timeout.

Parameters:

defaultTransactionTimeoutInSeconds - the default transaction timeout in seconds

Returns:

this configuration instance

setDefaultTransactionTimeoutInSeconds

public final void setDefaultTransactionTimeoutInSeconds(int defaultTransactionTimeoutInSeconds)

Allows BeanHandler to set the default transaction timeout.

getDefaultTransactionTimeoutInSeconds

public final int getDefaultTransactionTimeoutInSeconds()

Get default transaction timeout

Returns:

default transaction timeout in seconds

monitoring

public final Configuration monitoring(Configuration.Monitoring monitoring)

Builder to set the monitoring approach

Parameters:

monitoring - an non-null instance of Configuration.Monitoring

Returns:

this configuration instance

setMonitoring

public final void setMonitoring(String monitoring)

Allows BeanHandler to set the monitoring flag

getMonitoring

public final Configuration.Monitoring getMonitoring()

Get monitoring type, should not be null

dynamicConfig

public final Configuration dynamicConfig(boolean dynamicConfig)

Builder to set the dynamic config capability

Parameters:

dynamicConfig - true if dynamic config should be enabled; or false otherwise.

Returns:

this configuration instance

setDynamicConfig

public final void setDynamicConfig(boolean dynamicConfig)

Allows BeanHandler to set the dynamic configuration flag

getDynamicConfig

public final boolean getDynamicConfig()

Get flag for dynamicConfig

getMaxBytesLocalHeap

public long getMaxBytesLocalHeap()

Maximum amount of bytes the CacheManager will use on the heap

Returns:

amount of bytes, 0 is unbound

setMaxBytesLocalHeap

public void setMaxBytesLocalHeap(String maxBytesOnHeap)

Sets maximum amount of bytes the CacheManager will use on the Disk Tier.

Parameters:

maxBytesOnHeap - String representation of the size.

See Also:

MemoryUnit.parseSizeInBytes(String)

getMaxBytesLocalHeapAsString

public String getMaxBytesLocalHeapAsString()

Returns:

Original input for maxBytesLocalHeap

setMaxBytesLocalHeap

public void setMaxBytesLocalHeap(Long maxBytesOnHeap)

Sets the maximum amount of bytes the cache manager being configured will use on the OnHeap tier

Parameters:

maxBytesOnHeap - amount of bytes

maxBytesLocalHeap

public Configuration maxBytesLocalHeap(long amount,
                                       MemoryUnit memoryUnit)

Sets the maxOnHeap size for the cache being configured

Parameters:

amount - the amount of unit

memoryUnit - the actual unit

Returns:

this

See Also:

setMaxBytesLocalHeap(Long)

getMaxBytesLocalOffHeap

public long getMaxBytesLocalOffHeap()

Maximum amount of bytes the CacheManager will use on the OffHeap Tier.

Returns:

amount in bytes

setMaxBytesLocalOffHeap

public void setMaxBytesLocalOffHeap(String maxBytesOffHeap)

Sets maximum amount of bytes the CacheManager will use on the OffHeap Tier.

Parameters:

maxBytesOffHeap - String representation of the size.

See Also:

MemoryUnit.parseSizeInBytes(String)

getMaxBytesLocalOffHeapAsString

public String getMaxBytesLocalOffHeapAsString()

Returns:

Original input for maxBytesLocalOffHeap

getTotalConfiguredOffheap

public long getTotalConfiguredOffheap()

Returns:

Total amount offheap configured by current caches

setMaxBytesLocalOffHeap

public void setMaxBytesLocalOffHeap(Long maxBytesOffHeap)

Sets maximum amount of bytes the CacheManager will use on the OffHeap Tier.

Parameters:

maxBytesOffHeap - max bytes on disk in bytes. Needs be be greater than 0

maxBytesLocalOffHeap

public Configuration maxBytesLocalOffHeap(long amount,
                                          MemoryUnit memoryUnit)

Sets the maximum size for the OffHeap tier for all the caches this CacheManagers holds.

Parameters:

amount - the amount of unit

memoryUnit - the actual unit

Returns:

this

getMaxBytesLocalDisk

public long getMaxBytesLocalDisk()

Maximum amount of bytes the CacheManager will use on the Disk Tier.

Returns:

amount in bytes

setMaxBytesLocalDisk

public void setMaxBytesLocalDisk(String maxBytesOnDisk)

Sets maximum amount of bytes the CacheManager will use on the Disk Tier.

Parameters:

maxBytesOnDisk - String representation of the size.

See Also:

MemoryUnit.parseSizeInBytes(String)

getMaxBytesLocalDiskAsString

public String getMaxBytesLocalDiskAsString()

Returns:

Original input for maxBytesLocalDisk

setMaxBytesLocalDisk

public void setMaxBytesLocalDisk(Long maxBytesOnDisk)

Sets maximum amount of bytes the CacheManager will use on the Disk Tier.

Parameters:

maxBytesOnDisk - max bytes on disk in bytes. Needs be be greater than 0

maxBytesLocalDisk

public Configuration maxBytesLocalDisk(long amount,
                                       MemoryUnit memoryUnit)

Sets the maxOnDisk size

Parameters:

amount - the amount of unit

memoryUnit - the actual unit

Returns:

this

See Also:

setMaxBytesLocalDisk(Long)

diskStore

public final Configuration diskStore(DiskStoreConfiguration diskStoreConfigurationParameter)
                              throws ObjectExistsException

Builder to add a disk store to the cache manager, only one disk store can be added.

Parameters:

diskStoreConfigurationParameter - the disk store configuration to use

Returns:

this configuration instance

Throws:

ObjectExistsException - if the disk store has already been configured

addDiskStore

public final void addDiskStore(DiskStoreConfiguration diskStoreConfigurationParameter)
                        throws ObjectExistsException

Allows BeanHandler to add disk store location to the configuration.

Throws:

ObjectExistsException

sizeOfPolicy

public final Configuration sizeOfPolicy(SizeOfPolicyConfiguration sizeOfPolicyConfiguration)

Builder to set the default SizeOfPolicyConfiguration for this cache manager.

Parameters:

sizeOfPolicyConfiguration - the SizeOfPolicy Configuration

Returns:

this configuration instance

addSizeOfPolicy

public final void addSizeOfPolicy(SizeOfPolicyConfiguration sizeOfPolicy)

Sets the default SizeOfPolicyConfiguration for this cache manager.

Parameters:

sizeOfPolicy - the SizeOfPolicy Configuration

transactionManagerLookup

public final Configuration transactionManagerLookup(FactoryConfiguration transactionManagerLookupParameter)
                                             throws ObjectExistsException

Builder to add a transaction manager lookup class to the cache manager, only one of these can be added.

Parameters:

transactionManagerLookupParameter - the transaction manager lookup class to use

Returns:

this configuration instance

Throws:

ObjectExistsException - if the transaction manager lookup has already been configured

addTransactionManagerLookup

public final void addTransactionManagerLookup(FactoryConfiguration transactionManagerLookupParameter)
                                       throws ObjectExistsException

Allows BeanHandler to add transaction manager lookup to the configuration.

Throws:

ObjectExistsException

cacheManagerEventListenerFactory

public final Configuration cacheManagerEventListenerFactory(FactoryConfiguration cacheManagerEventListenerFactoryConfiguration)

Builder to set the event lister through a factory, only one of these can be added and subsequent calls are ignored.

Returns:

this configuration instance

addCacheManagerEventListenerFactory

public final void addCacheManagerEventListenerFactory(FactoryConfiguration cacheManagerEventListenerFactoryConfiguration)

Allows BeanHandler to add the CacheManagerEventListener to the configuration.

cacheManagerPeerProviderFactory

public final Configuration cacheManagerPeerProviderFactory(FactoryConfiguration factory)

Builder method to add a peer provider through a factory.

Returns:

this configuration instance

addCacheManagerPeerProviderFactory

public final void addCacheManagerPeerProviderFactory(FactoryConfiguration factory)

Adds a CacheManagerPeerProvider through FactoryConfiguration.

cacheManagerPeerListenerFactory

public final Configuration cacheManagerPeerListenerFactory(FactoryConfiguration factory)

Builder method to add a peer listener through a factory.

Returns:

this configuration instance

addCacheManagerPeerListenerFactory

public final void addCacheManagerPeerListenerFactory(FactoryConfiguration factory)

Adds a CacheManagerPeerListener through FactoryConfiguration.

terracotta

public final Configuration terracotta(TerracottaClientConfiguration terracottaConfiguration)
                               throws ObjectExistsException

Builder method to Terracotta capabilities to the cache manager through a dedicated configuration, this can only be used once.

Returns:

this configuration instance

Throws:

ObjectExistsException - if the Terracotta config has already been configured

addTerracottaConfig

public final void addTerracottaConfig(TerracottaClientConfiguration terracottaConfiguration)
                               throws ObjectExistsException

Allows BeanHandler to add a Terracotta configuration to the configuration

Throws:

ObjectExistsException

managementRESTService

public final Configuration managementRESTService(ManagementRESTServiceConfiguration cfg)
                                          throws ObjectExistsException

Builder method to REST management capabilities to the cache manager through a dedicated configuration, this can only be used once.

Returns:

this configuration instance

Throws:

ObjectExistsException - if the REST management config has already been configured

addManagementRESTService

public final void addManagementRESTService(ManagementRESTServiceConfiguration managementRESTServiceConfiguration)
                                    throws ObjectExistsException

Allows BeanHandler to add a ManagementRESTService configuration to the configuration

Throws:

ObjectExistsException

defaultCache

public final Configuration defaultCache(CacheConfiguration defaultCacheConfiguration)
                                 throws ObjectExistsException

Builder method to set the default cache configuration, this can only be used once.

Returns:

this configuration instance

Throws:

ObjectExistsException - if the default cache config has already been configured

addDefaultCache

public final void addDefaultCache(CacheConfiguration defaultCacheConfiguration)
                           throws ObjectExistsException

Allows BeanHandler to add a default configuration to the configuration.

Throws:

ObjectExistsException

cache

public final Configuration cache(CacheConfiguration cacheConfiguration)
                          throws ObjectExistsException

Builder to add a new cache through its config

Returns:

this configuration instance

Throws:

ObjectExistsException - if a cache with the same name already exists, or if the name conflicts with the name of the default cache

addCache

public final void addCache(CacheConfiguration cacheConfiguration)
                    throws ObjectExistsException

Allows BeanHandler to add Cache Configurations to the configuration.

Throws:

ObjectExistsException

getCacheConfigurationsKeySet

public final Set<String> getCacheConfigurationsKeySet()

Gets a Map of cacheConfigurations.

getDefaultCacheConfiguration

public final CacheConfiguration getDefaultCacheConfiguration()

Returns:

the configuration's default cache configuration

setDefaultCacheConfiguration

public final void setDefaultCacheConfiguration(CacheConfiguration defaultCacheConfiguration)

Parameters:

defaultCacheConfiguration -

getDiskStoreConfiguration

public final DiskStoreConfiguration getDiskStoreConfiguration()

Gets the disk store configuration.

getSizeOfPolicyConfiguration

public final SizeOfPolicyConfiguration getSizeOfPolicyConfiguration()

Gets the SizeOf policy configuration.

getTransactionManagerLookupConfiguration

public final FactoryConfiguration getTransactionManagerLookupConfiguration()

Gets the transaction manager lookup configuration.

getCacheManagerPeerProviderFactoryConfiguration

public final List<FactoryConfiguration> getCacheManagerPeerProviderFactoryConfiguration()

Gets the CacheManagerPeerProvider factory configuration.

getCacheManagerPeerListenerFactoryConfigurations

public final List<FactoryConfiguration> getCacheManagerPeerListenerFactoryConfigurations()

Gets the CacheManagerPeerListener factory configuration.

getManagementRESTService

public final ManagementRESTServiceConfiguration getManagementRESTService()

Gets the ManagementRESTServiceConfiguration

getCacheManagerEventListenerFactoryConfiguration

public final FactoryConfiguration getCacheManagerEventListenerFactoryConfiguration()

Gets the CacheManagerEventListener factory configuration.

getTerracottaConfiguration

public final TerracottaClientConfiguration getTerracottaConfiguration()

Gets the TerracottaClientConfiguration

getCacheConfigurations

public final Map<String,CacheConfiguration> getCacheConfigurations()

Gets a Map of cache configurations, keyed by name.

source

public final Configuration source(ConfigurationSource configurationSource)

Builder to set the configuration source.

Returns:

this configuration instance

setSource

public final void setSource(ConfigurationSource configurationSource)

Sets the configuration source.

Parameters:

configurationSource - an informative description of the source, preferably including the resource name and location.

getConfigurationSource

public final ConfigurationSource getConfigurationSource()

Gets a description of the source from which this configuration was created.

addPropertyChangeListener

public boolean addPropertyChangeListener(PropertyChangeListener listener)

Adds a PropertyChangeListener for this configuration

Parameters:

listener - the listener instance

Returns:

true if added, false otherwise

removePropertyChangeListener

public boolean removePropertyChangeListener(PropertyChangeListener listener)

Removes a PropertyChangeListener for this configuration

Parameters:

listener - the listener to be removed

Returns:

true if removed, false otherwise

getClassLoader

public ClassLoader getClassLoader()

setClassLoader

public void setClassLoader(ClassLoader loader)

Set the classloader for the cache manager (and it's associated caches) to use when creating application objects (eg. cache values, event listeners, etc). The default classloading behavior is to prefer Thread.currentThread().getContextClassLoader() and fallback to the classloader that loaded ehcache itself.

Parameters:

loader - the classloader to use

cleanup

public void cleanup()