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.constructs |
The constructs package builds on top of the core ehcache classes to create
implementations for common caching patterns.
|
net.sf.ehcache.constructs.classloader |
ClassLoader contstructs package
|
net.sf.ehcache.constructs.nonstop |
Ehcache-nonstopcache package
|
net.sf.ehcache.distribution |
This package is for cache replication.
|
net.sf.ehcache.event |
This package contains interfaces and classes for listening to events.
|
net.sf.ehcache.hibernate |
This package contains interfaces and classes for Hibernate3.1 and higher.
|
net.sf.ehcache.hibernate.management.impl |
This package contains JMX related classes for Hibernate and ehcache statistics
|
net.sf.ehcache.management |
This package contains JMX MBeans and implementations for management of ehcache.
|
net.sf.ehcache.management.provider |
This package contains classes related to MBeanRegistrationProvider and its implementation.
|
net.sf.ehcache.management.sampled |
This package contains classes related to MBeans with Sampled Statistics.
|
net.sf.ehcache.terracotta |
This package contains the Terracotta integration functionalities.
|
Modifier and Type | Field and Description |
---|---|
private CacheManager |
CacheInitializationHelper.cacheManager |
private CacheManager |
Cache.cacheManager |
private static CacheManager |
CacheManager.singleton
The Singleton Instance.
|
Modifier and Type | Field and Description |
---|---|
static java.util.List<CacheManager> |
CacheManager.ALL_CACHE_MANAGERS
Keeps track of all known CacheManagers.
|
private static java.util.Map<java.lang.String,CacheManager> |
CacheManager.CACHE_MANAGERS_MAP |
private static java.util.IdentityHashMap<CacheManager,java.lang.String> |
CacheManager.CACHE_MANAGERS_REVERSE_MAP |
Modifier and Type | Method and Description |
---|---|
static CacheManager |
CacheManager.create()
A factory method to create a singleton CacheManager with default config, or return it if it exists.
|
static CacheManager |
CacheManager.create(Configuration config)
A factory method to create a singleton CacheManager from a net.sf.ehcache.config.Configuration.
|
static CacheManager |
CacheManager.create(java.io.InputStream inputStream)
A factory method to create a singleton CacheManager from a java.io.InputStream.
|
static CacheManager |
CacheManager.create(java.lang.String configurationFileName)
A factory method to create a singleton CacheManager with a specified configuration.
|
static CacheManager |
CacheManager.create(java.net.URL configurationFileURL)
A factory method to create a singleton CacheManager from an URL.
|
CacheManager |
Ehcache.getCacheManager()
Gets the CacheManager managing this cache.
|
CacheManager |
Cache.getCacheManager()
Gets the CacheManager managing this cache.
|
static CacheManager |
CacheManager.getCacheManager(java.lang.String name)
Checks if a cacheManager already exists for a given name and gets it.
|
static CacheManager |
CacheManager.getInstance()
A factory method to create a singleton CacheManager with default config, or return it if it exists.
|
static CacheManager |
CacheManager.newInstance()
A factory method to create a CacheManager with default config, or return it if it exists.
|
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.
|
static CacheManager |
CacheManager.newInstance(java.io.InputStream inputStream)
A factory method to create a CacheManager from a java.io.InputStream.
|
static CacheManager |
CacheManager.newInstance(java.lang.String configurationFileName)
A factory method to create a CacheManager with a specified configuration.
|
static CacheManager |
CacheManager.newInstance(java.net.URL configurationFileURL)
A factory method to create a CacheManager from an URL.
|
Modifier and Type | Method and Description |
---|---|
void |
Ehcache.setCacheManager(CacheManager cacheManager)
Sets the CacheManager
|
void |
Cache.setCacheManager(CacheManager cacheManager)
For use by CacheManager.
|
Constructor and Description |
---|
CacheInitializationHelper(CacheManager cacheManager)
Create a cache initializer with the given
CacheManager |
Modifier and Type | Field and Description |
---|---|
private CacheManager |
Configuration.RuntimeCfg.cacheManager |
private CacheManager |
ConfigurationHelper.cacheManager |
Modifier and Type | Method and Description |
---|---|
private void |
CacheConfiguration.consolidatePersistenceSettings(CacheManager manager) |
CacheManagerEventListener |
ConfigurationHelper.createCacheManagerEventListener(CacheManager cacheManager)
Tries to load the class specified.
|
private void |
CacheConfiguration.freezePoolUsages(CacheManager cacheManager) |
(package private) static java.util.Set<Cache> |
Configuration.getAllActiveCaches(CacheManager cacheManager)
Returns all active caches managed by the Manager
|
private void |
CacheConfiguration.registerCacheConfiguration(CacheManager cacheManager) |
void |
CacheConfiguration.setupFor(CacheManager cacheManager)
Sets up the CacheConfiguration for runtime consumption, also registers this cache configuration with the cache manager's configuration
|
void |
CacheConfiguration.setupFor(CacheManager cacheManager,
boolean register)
Sets up the CacheConfiguration for runtime consumption
|
Configuration.RuntimeCfg |
Configuration.setupFor(CacheManager cacheManager,
java.lang.String fallbackName)
Freezes part of the configuration that need to be, and runs validation checks on the Configuration.
|
private void |
CacheConfiguration.updateCacheManagerPoolSizes(CacheManager cacheManager) |
(package private) java.util.List<ConfigError> |
CacheConfiguration.verifyPoolAllocationsBeforeAddingTo(CacheManager cacheManager,
long managerMaxBytesLocalHeap,
long managerMaxBytesLocalOffHeap,
long managerMaxBytesLocalDisk)
Will verify that we don't overallocate pools
|
private void |
CacheConfiguration.warnMaxEntriesLocalHeap(boolean register,
CacheManager cacheManager) |
Constructor and Description |
---|
ConfigurationHelper(CacheManager cacheManager,
Configuration configuration)
Only Constructor
|
RuntimeCfg(CacheManager cacheManager,
java.lang.String fallbackName)
Constructor
|
Modifier and Type | Method and Description |
---|---|
static java.lang.String |
ConfigurationUtil.generateCacheManagerConfigurationText(CacheManager cacheManager)
Generates Configuration text from a
CacheManager |
(package private) static void |
ConfigurationUtil.visitConfiguration(CacheManager cacheManager,
NodeElementVisitor visitor)
package protected access so that tests can have access
|
Modifier and Type | Field and Description |
---|---|
private CacheManager |
ConfigurationElement.cacheManager |
Constructor and Description |
---|
ConfigurationElement(CacheManager cacheManager)
Constructor accepting the
CacheManager . |
Modifier and Type | Method and Description |
---|---|
CacheManager |
EhcacheDecoratorAdapter.getCacheManager()
Gets the CacheManager managing this cache.
|
Modifier and Type | Method and Description |
---|---|
void |
EhcacheDecoratorAdapter.setCacheManager(CacheManager cacheManager)
Sets the CacheManager
|
Modifier and Type | Method and Description |
---|---|
CacheManager |
ClassLoaderAwareCache.getCacheManager()
Gets the CacheManager managing this cache.
|
Modifier and Type | Method and Description |
---|---|
void |
ClassLoaderAwareCache.setCacheManager(CacheManager arg0)
Sets the CacheManager
|
Modifier and Type | Method and Description |
---|---|
NonstopExecutorService |
NonstopExecutorServiceFactory.getOrCreateNonstopExecutorService(CacheManager cacheManager)
Creates a
NonstopExecutorService and returns it if not already created |
NonstopExecutorService |
CacheManagerExecutorServiceFactory.getOrCreateNonstopExecutorService(CacheManager cacheManager)
Creates a
NonstopExecutorService and returns it if not already created |
void |
NonstopExecutorServiceFactory.shutdown(CacheManager cacheManager)
Shuts down the
NonstopExecutorService associated with the CacheManager |
void |
CacheManagerExecutorServiceFactory.shutdown(CacheManager cacheManager)
Shuts down the
NonstopExecutorService associated with the CacheManager |
Modifier and Type | Field and Description |
---|---|
private CacheManager |
MulticastKeepaliveHeartbeatSender.cacheManager |
protected CacheManager |
RMICacheManagerPeerProvider.cacheManager
The CacheManager this peer provider is associated with.
|
private CacheManager |
RMICacheManagerPeerListener.cacheManager |
Modifier and Type | Method and Description |
---|---|
CacheManager |
RMICacheManagerPeerProvider.getCacheManager()
The cacheManager this provider is bound to
|
Modifier and Type | Method and Description |
---|---|
protected CacheManagerPeerProvider |
RMICacheManagerPeerProviderFactory.createAutomaticallyConfiguredCachePeerProvider(CacheManager cacheManager,
java.util.Properties properties)
peerDiscovery=automatic, multicastGroupAddress=230.0.0.1, multicastGroupPort=4446, multicastPacketTimeToLive=255
|
CacheManagerPeerListener |
RMICacheManagerPeerListenerFactory.createCachePeerListener(CacheManager cacheManager,
java.util.Properties properties) |
abstract CacheManagerPeerListener |
CacheManagerPeerListenerFactory.createCachePeerListener(CacheManager cacheManager,
java.util.Properties properties)
Creates a peer provider.
|
abstract CacheManagerPeerProvider |
CacheManagerPeerProviderFactory.createCachePeerProvider(CacheManager cacheManager,
java.util.Properties properties)
Create a peer provider.
|
CacheManagerPeerProvider |
RMICacheManagerPeerProviderFactory.createCachePeerProvider(CacheManager cacheManager,
java.util.Properties properties) |
protected CacheManagerPeerListener |
RMICacheManagerPeerListenerFactory.doCreateCachePeerListener(java.lang.String hostName,
java.lang.Integer port,
java.lang.Integer remoteObjectPort,
CacheManager cacheManager,
java.lang.Integer socketTimeoutMillis)
A template method to actually create the factory
|
Constructor and Description |
---|
MulticastKeepaliveHeartbeatSender(CacheManager cacheManager,
java.net.InetAddress multicastAddress,
java.lang.Integer multicastPort,
java.lang.Integer timeToLive,
java.net.InetAddress hostAddress)
Constructor.
|
MulticastRMICacheManagerPeerProvider(CacheManager cacheManager,
java.net.InetAddress groupMulticastAddress,
java.lang.Integer groupMulticastPort,
java.lang.Integer timeToLive,
java.net.InetAddress hostAddress)
Creates and starts a multicast peer provider
|
RMICacheManagerPeerListener(java.lang.String hostName,
java.lang.Integer port,
java.lang.Integer remoteObjectPort,
CacheManager cacheManager,
java.lang.Integer socketTimeoutMillis)
Constructor with full arguments.
|
RMICacheManagerPeerProvider(CacheManager cacheManager)
Constructor
|
Modifier and Type | Method and Description |
---|---|
abstract CacheManagerEventListener |
CacheManagerEventListenerFactory.createCacheManagerEventListener(CacheManager cacheManager,
java.util.Properties properties)
Create a
CacheEventListener |
Modifier and Type | Field and Description |
---|---|
protected CacheManager |
AbstractEhcacheProvider.manager
CacheManager instance that creates/builds Cache instances for this provider.
|
protected CacheManager |
AbstractEhcacheRegionFactory.manager
Ehcache CacheManager that supplied Ehcache instances for this Hibernate RegionFactory.
|
Modifier and Type | Field and Description |
---|---|
private CacheManager |
EhcacheStatsImpl.cacheManager |
private CacheManager |
ProviderMBeanRegistrationHelper.RegisterMBeansTask.manager |
Modifier and Type | Method and Description |
---|---|
private void |
EhcacheHibernateMBeanRegistrationImpl.registerBean(java.lang.String name,
CacheManager manager) |
void |
ProviderMBeanRegistrationHelper.registerMBean(CacheManager manager,
java.util.Properties properties)
Registers mbean for the input cache manager and the session factory name
|
void |
EhcacheHibernateMBeanRegistration.registerMBeanForCacheManager(CacheManager manager,
java.util.Properties properties)
Registers MBean for the input manager and session factory properties.
|
void |
EhcacheHibernateMBeanRegistrationImpl.registerMBeanForCacheManager(CacheManager manager,
java.util.Properties properties)
Registers MBean for the input manager and session factory properties.
|
Constructor and Description |
---|
EhcacheHibernate(CacheManager manager)
Constructor accepting the backing
CacheManager |
EhcacheStatsImpl(CacheManager manager)
Constructor accepting the backing
CacheManager |
RegisterMBeansTask(EhcacheHibernateMBeanRegistrationImpl ehcacheHibernateMBeanRegistration,
CacheManager manager,
java.util.Properties properties) |
Modifier and Type | Field and Description |
---|---|
private CacheManager |
ManagementService.backingCacheManager |
private CacheManager |
CacheManager.cacheManager |
Modifier and Type | Method and Description |
---|---|
(package private) static javax.management.ObjectName |
CacheManager.createObjectName(CacheManager cacheManager)
Creates an object name using the scheme "net.sf.ehcache:type=CacheManager,name=
|
void |
ManagementServer.register(CacheManager managedResource)
Puts the submitted resource under the purview of this
ManagementServer . |
static void |
ManagementServerLoader.register(CacheManager cacheManager,
ManagementRESTServiceConfiguration managementRESTServiceConfiguration)
Register a cacheManager to management rest server.
|
static void |
ManagementService.registerMBeans(CacheManager cacheManager,
javax.management.MBeanServer mBeanServer,
boolean registerCacheManager,
boolean registerCaches,
boolean registerCacheConfigurations,
boolean registerCacheStatistics)
A convenience static method which creates a ManagementService and initialises it with the
supplied parameters.
|
static void |
ManagementService.registerMBeans(CacheManager cacheManager,
javax.management.MBeanServer mBeanServer,
boolean registerCacheManager,
boolean registerCaches,
boolean registerCacheConfigurations,
boolean registerCacheStatistics,
boolean registerCacheStores)
A convenience static method which creates a ManagementService and initialises it with the
supplied parameters.
|
void |
ManagementServer.unregister(CacheManager managedResource)
Removes the submitted resource under the purview of this
ManagementServer . |
static void |
ManagementServerLoader.unregister(java.lang.String registeredMgmtSvrBind,
CacheManager cacheManager)
Unregister a cache manager from a management rest server
If it is the last cache manager bound to this server, stops the server too.
|
Constructor and Description |
---|
CacheManager(CacheManager cacheManager)
Create a management CacheManager
|
ManagementService(CacheManager cacheManager,
javax.management.MBeanServer mBeanServer,
boolean registerCacheManager,
boolean registerCaches,
boolean registerCacheConfigurations,
boolean registerCacheStatistics)
A constructor for a management service for a range of possible MBeans.
|
ManagementService(CacheManager cacheManager,
javax.management.MBeanServer mBeanServer,
boolean registerCacheManager,
boolean registerCaches,
boolean registerCacheConfigurations,
boolean registerCacheStatistics,
boolean registerCacheStores)
A constructor for a management service for a range of possible MBeans.
|
Modifier and Type | Field and Description |
---|---|
private CacheManager |
MBeanRegistrationProviderImpl.cachedCacheManager |
Modifier and Type | Method and Description |
---|---|
void |
MBeanRegistrationProvider.initialize(CacheManager cacheManager,
ClusteredInstanceFactory clusteredInstanceFactory)
Initialize MBeanRegistration if necessary for the cacheManager
|
void |
NullMBeanRegistrationProvider.initialize(CacheManager cacheManager,
ClusteredInstanceFactory clusteredInstanceFactory)
A null implementation of
MBeanRegistrationProvider.initialize(CacheManager, ClusteredInstanceFactory) |
void |
MBeanRegistrationProviderImpl.initialize(CacheManager cacheManager,
ClusteredInstanceFactory clusteredInstanceFactory)
Initialize MBeanRegistration if necessary for the cacheManager
|
Modifier and Type | Field and Description |
---|---|
private CacheManager |
SampledMBeanRegistrationProvider.cacheManager |
private CacheManager |
CacheManagerSamplerImpl.cacheManager |
Modifier and Type | Method and Description |
---|---|
void |
SampledMBeanRegistrationProvider.initialize(CacheManager cacheManagerParam,
ClusteredInstanceFactory clusteredInstanceFactory)
Initialize MBeanRegistration if necessary for the cacheManager
|
Constructor and Description |
---|
CacheManagerSamplerImpl(CacheManager cacheManager)
Constructor taking the backing
CacheManager |
SampledCacheManager(CacheManager cacheManager)
Constructor taking the backing
CacheManager |
Modifier and Type | Field and Description |
---|---|
private CacheManager |
TerracottaClient.cacheManager |
Modifier and Type | Field and Description |
---|---|
private static WeakIdentityConcurrentMap<CacheManager,java.util.concurrent.ScheduledExecutorService> |
KeySnapshotter.INSTANCES |
Modifier and Type | Method and Description |
---|---|
(package private) static java.util.Collection<CacheManager> |
KeySnapshotter.getKnownCacheManagers()
Accessor to all known cacheManagers (which are also bound to a ScheduledExecutorService)
|
Constructor and Description |
---|
TerracottaClient(CacheManager cacheManager,
TerracottaClientRejoinListener rejoinAction,
TerracottaClientConfiguration terracottaClientConfiguration)
Constructor accepting the
TerracottaClientRejoinListener and the TerracottaClientConfiguration |