Package | Description |
---|---|
net.sf.ehcache |
This package contains the public API for using ehcache.
|
net.sf.ehcache.config |
This package contains the cache configuration code.
|
net.sf.ehcache.config.generator |
This package contains utility classes for generating configuration texts.
|
net.sf.ehcache.config.generator.model.elements |
This package contains utility classes encapsulating ideas of Elements and Attributes from the ehcache.xsd
|
net.sf.ehcache.hibernate |
This package contains interfaces and classes for Hibernate3.1 and higher.
|
net.sf.ehcache.management.provider |
This package contains classes related to MBeanRegistrationProvider and its implementation.
|
Modifier and Type | Method and Description |
---|---|
Configuration |
CacheManager.getConfiguration()
Get the CacheManager configuration
|
private Configuration |
CacheManager.parseConfiguration(java.lang.String configurationFileName,
java.net.URL configurationURL,
java.io.InputStream configurationInputStream)
Loads configuration, either from the supplied
ConfigurationHelper or by creating a new Configuration instance
from the configuration file referred to by file, inputstream or URL. |
Modifier and Type | Method and Description |
---|---|
private void |
CacheManager.assertNoCacheManagerExistsWithSameName(Configuration configuration) |
static CacheManager |
CacheManager.create(Configuration config)
A factory method to create a singleton CacheManager from a net.sf.ehcache.config.Configuration.
|
private void |
CacheManager.doInit(Configuration configuration) |
protected void |
CacheManager.init(Configuration initialConfiguration,
java.lang.String configurationFileName,
java.net.URL configurationURL,
java.io.InputStream configurationInputStream)
initialises the CacheManager
|
static CacheManager |
CacheManager.newInstance(Configuration config)
A factory method to create a CacheManager from a net.sf.ehcache.config.Configuration.
|
private static CacheManager |
CacheManager.newInstance(Configuration configuration,
java.lang.String msg)
Returns a new cacheManager or returns already created one.
|
Constructor and Description |
---|
CacheManager(Configuration configuration)
An constructor for CacheManager, which takes a configuration object, rather than one created by parsing
an ehcache.xml file.
|
Modifier and Type | Field and Description |
---|---|
private Configuration |
ConfigurationHelper.configuration |
Modifier and Type | Method and Description |
---|---|
Configuration |
Configuration.cache(CacheConfiguration cacheConfiguration)
Builder to add a new cache through its config
|
Configuration |
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 |
Configuration.cacheManagerPeerListenerFactory(FactoryConfiguration factory)
Builder method to add a peer listener through a factory.
|
Configuration |
Configuration.cacheManagerPeerProviderFactory(FactoryConfiguration factory)
Builder method to add a peer provider through a factory.
|
Configuration |
Configuration.defaultCache(CacheConfiguration defaultCacheConfiguration)
Builder method to set the default cache configuration, this can only be used once.
|
Configuration |
Configuration.defaultTransactionTimeoutInSeconds(int defaultTransactionTimeoutInSeconds)
Builder to set the default transaction timeout.
|
Configuration |
Configuration.diskStore(DiskStoreConfiguration diskStoreConfigurationParameter)
Builder to add a disk store to the cache manager, only one disk store can be added.
|
Configuration |
Configuration.dynamicConfig(boolean dynamicConfig)
Builder to set the dynamic config capability
|
Configuration |
Configuration.RuntimeCfg.getConfiguration() |
Configuration |
ConfigurationHelper.getConfigurationBean() |
Configuration |
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 |
Configuration.maxBytesLocalDisk(long amount,
MemoryUnit memoryUnit)
Sets the maxOnDisk size
|
Configuration |
Configuration.maxBytesLocalHeap(long amount,
MemoryUnit memoryUnit)
Sets the maxOnHeap size for the cache being configured
|
Configuration |
Configuration.maxBytesLocalOffHeap(long amount,
MemoryUnit memoryUnit)
Sets the maximum size for the OffHeap tier for all the caches this CacheManagers holds.
|
Configuration |
Configuration.monitoring(Configuration.Monitoring monitoring)
Builder to set the monitoring approach
|
Configuration |
Configuration.name(java.lang.String name)
Builder to set the cache manager name.
|
static Configuration |
ConfigurationFactory.parseConfiguration()
Configures a bean from an XML file in the classpath.
|
static Configuration |
ConfigurationFactory.parseConfiguration(java.io.File file)
Configures a bean from an XML file.
|
static Configuration |
ConfigurationFactory.parseConfiguration(java.io.InputStream inputStream)
Configures a bean from an XML input stream.
|
static Configuration |
ConfigurationFactory.parseConfiguration(java.net.URL url)
Configures a bean from an XML file available as an URL.
|
Configuration |
Configuration.sizeOfPolicy(SizeOfPolicyConfiguration sizeOfPolicyConfiguration)
Builder to set the default SizeOfPolicyConfiguration for this cache manager.
|
Configuration |
Configuration.source(ConfigurationSource configurationSource)
Builder to set the configuration source.
|
Configuration |
Configuration.terracotta(TerracottaClientConfiguration terracottaConfiguration)
Builder method to Terracotta capabilities to the cache manager through a dedicated configuration, this can only be used once.
|
Configuration |
Configuration.transactionManagerLookup(FactoryConfiguration transactionManagerLookupParameter)
Builder to add a transaction manager lookup class to the cache manager, only one of these can be added.
|
Configuration |
Configuration.updateCheck(boolean updateCheck)
Builder to set the state of the automated update check.
|
Modifier and Type | Method and Description |
---|---|
(package private) void |
CacheConfiguration.configCachePools(Configuration configuration)
Configures the cache pools
|
private static SizeOfPolicyConfiguration |
SizeOfPolicyConfiguration.resolvePolicy(Configuration configuration,
CacheConfiguration cacheConfiguration) |
java.util.Collection<ConfigError> |
CacheConfiguration.validate(Configuration configuration)
Validates the configuration
|
(package private) java.util.List<CacheConfigError> |
CacheConfiguration.validateCachePools(Configuration configuration)
Validates the CacheConfiguration against the CacheManager's Configuration
|
private void |
CacheConfiguration.validateTerracottaConfig(Configuration configuration,
java.util.Collection<ConfigError> errors) |
private void |
CacheConfiguration.verifyClusteredCacheConfiguration(Configuration configuration,
java.util.Collection<ConfigError> errors) |
Constructor and Description |
---|
ConfigurationHelper(CacheManager cacheManager,
Configuration configuration)
Only Constructor
|
Modifier and Type | Method and Description |
---|---|
abstract Configuration |
ConfigurationSource.createConfiguration()
Abstract method used for creating a
Configuration based on the source |
Configuration |
ConfigurationSource.FileNameSource.createConfiguration()
Abstract method used for creating a
Configuration based on the source |
Configuration |
ConfigurationSource.URLConfigurationSource.createConfiguration()
Abstract method used for creating a
Configuration based on the source |
Configuration |
ConfigurationSource.InputStreamConfigurationSource.createConfiguration()
Abstract method used for creating a
Configuration based on the source |
Configuration |
ConfigurationSource.DefaultConfigurationSource.createConfiguration()
Abstract method used for creating a
Configuration based on the source |
Modifier and Type | Method and Description |
---|---|
java.lang.String |
ConfigurationGenerator.generate(Configuration configuration,
CacheConfiguration cacheConfiguration)
Deprecated.
use appropriate methods in
ConfigurationUtil instead |
java.lang.String |
ConfigurationGenerator.generate(Configuration configuration,
CacheConfiguration defaultCacheConfiguration,
java.util.Map<java.lang.String,CacheConfiguration> cacheConfigs)
Deprecated.
use appropriate methods in
ConfigurationUtil instead |
static java.lang.String |
ConfigurationUtil.generateCacheConfigurationText(Configuration configuration,
CacheConfiguration cacheConfiguration)
Generates configuration text for a
CacheConfiguration |
static java.lang.String |
ConfigurationUtil.generateCacheManagerConfigurationText(Configuration configuration)
Generates Configuration text from a
Configuration |
(package private) static void |
ConfigurationUtil.visitCacheConfiguration(Configuration configuration,
CacheConfiguration cacheConfiguration,
NodeElementVisitor configGenerator)
package protected access so that tests can have access
|
(package private) static void |
ConfigurationUtil.visitConfiguration(Configuration configuration,
NodeElementVisitor visitor)
package protected access so that tests can have access
|
Modifier and Type | Field and Description |
---|---|
private Configuration |
ConfigurationElement.configuration |
private Configuration |
CacheConfigurationElement.configuration |
private Configuration |
DefaultCacheConfigurationElement.configuration |
Modifier and Type | Method and Description |
---|---|
static void |
CacheConfigurationElement.addCommonAttributesWithDefaultCache(NodeElement element,
Configuration configuration,
CacheConfiguration cacheConfiguration)
Adds all attributes which are common with the "defaultCache" element in ehcache.xsd
|
Constructor and Description |
---|
CacheConfigurationElement(NodeElement parent,
Configuration configuration,
CacheConfiguration cacheConfiguration)
Constructor accepting the parent and the
CacheConfiguration |
ConfigurationElement(Configuration configuration)
Constructor accepting the
Configuration . |
DefaultCacheConfigurationElement(NodeElement parent,
Configuration configuration,
CacheConfiguration cacheConfiguration)
Constructor accepting the parent and the
CacheConfiguration |
Modifier and Type | Method and Description |
---|---|
(package private) static Configuration |
HibernateUtil.loadAndCorrectConfiguration(java.net.URL url)
Create a cache manager configuration from the supplied url, correcting it for Hibernate compatibility.
|
(package private) static Configuration |
HibernateUtil.overwriteCacheManagerIfConfigured(Configuration configuration,
java.util.Properties properties)
Will overwrite the CacheManager name from the passed in configuration with the value of
net.sf.ehcache.hibernate.AbstractEhcacheRegionFactory#NET_SF_EHCACHE_CACHE_MANAGER_NAME of the passed in Properties
|
Modifier and Type | Method and Description |
---|---|
(package private) static Configuration |
HibernateUtil.overwriteCacheManagerIfConfigured(Configuration configuration,
java.util.Properties properties)
Will overwrite the CacheManager name from the passed in configuration with the value of
net.sf.ehcache.hibernate.AbstractEhcacheRegionFactory#NET_SF_EHCACHE_CACHE_MANAGER_NAME of the passed in Properties
|
Modifier and Type | Method and Description |
---|---|
MBeanRegistrationProvider |
MBeanRegistrationProviderFactoryImpl.createMBeanRegistrationProvider(Configuration config)
Factory Method for creating
MBeanRegistrationProvider |
MBeanRegistrationProvider |
MBeanRegistrationProviderFactory.createMBeanRegistrationProvider(Configuration config)
Factory Method for creating
MBeanRegistrationProvider |
Constructor and Description |
---|
MBeanRegistrationProviderImpl(Configuration configuration)
Constructor accepting the
Configuration |