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.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.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.search.query |
This package contains the QueryMangerBuilder and the QueryManager interface to support BMSQL.
|
net.sf.ehcache.terracotta |
This package contains the Terracotta integration functionalities.
|
Modifier and Type | Field and Description |
---|---|
static List<CacheManager> |
CacheManager.ALL_CACHE_MANAGERS
Keeps track of all known CacheManagers.
|
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(InputStream inputStream)
A factory method to create a singleton CacheManager from a java.io.InputStream.
|
static CacheManager |
CacheManager.create(String configurationFileName)
A factory method to create a singleton CacheManager with a specified configuration.
|
static CacheManager |
CacheManager.create(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(String name)
Checks if a cacheManager already exists for a given name and gets it.
|
static CacheManager |
CacheInitializationHelper.getInitializingCacheManager(String name)
Get a currently initializing
CacheManager by name |
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.
|
static CacheManager |
CacheManager.newInstance(InputStream inputStream)
A factory method to create a CacheManager from a java.io.InputStream.
|
static CacheManager |
CacheManager.newInstance(String configurationFileName)
A factory method to create a CacheManager with a specified configuration.
|
static CacheManager |
CacheManager.newInstance(URL configurationFileURL)
A factory method to create a CacheManager from an URL.
|
Modifier and Type | Method and Description |
---|---|
static void |
CacheInitializationHelper.initializeEhcache(CacheManager cacheManager,
Ehcache cache)
Initialize the given
Ehcache using the given CacheManager |
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 | Method and Description |
---|---|
CacheManagerEventListener |
ConfigurationHelper.createCacheManagerEventListener(CacheManager cacheManager)
Tries to load the class specified.
|
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,
String parentCache)
Sets up the CacheConfiguration for runtime consumption
|
Configuration.RuntimeCfg |
Configuration.setupFor(CacheManager cacheManager,
String fallbackName)
Freezes part of the configuration that need to be, and runs validation checks on the Configuration.
|
Constructor and Description |
---|
ConfigurationHelper(CacheManager cacheManager,
Configuration configuration)
Only Constructor
|
RuntimeCfg(CacheManager cacheManager,
String fallbackName)
Constructor
|
Modifier and Type | Method and Description |
---|---|
static String |
ConfigurationUtil.generateCacheManagerConfigurationText(CacheManager cacheManager)
Generates Configuration text from a
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 | Field and Description |
---|---|
protected CacheManager |
RMICacheManagerPeerProvider.cacheManager
The CacheManager this peer provider is associated with.
|
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,
Properties properties)
peerDiscovery=automatic, multicastGroupAddress=230.0.0.1, multicastGroupPort=4446, multicastPacketTimeToLive=255
|
abstract CacheManagerPeerListener |
CacheManagerPeerListenerFactory.createCachePeerListener(CacheManager cacheManager,
Properties properties)
Creates a peer provider.
|
CacheManagerPeerListener |
RMICacheManagerPeerListenerFactory.createCachePeerListener(CacheManager cacheManager,
Properties properties) |
CacheManagerPeerProvider |
RMICacheManagerPeerProviderFactory.createCachePeerProvider(CacheManager cacheManager,
Properties properties) |
abstract CacheManagerPeerProvider |
CacheManagerPeerProviderFactory.createCachePeerProvider(CacheManager cacheManager,
Properties properties)
Create a peer provider.
|
protected CacheManagerPeerListener |
RMICacheManagerPeerListenerFactory.doCreateCachePeerListener(String hostName,
Integer port,
Integer remoteObjectPort,
CacheManager cacheManager,
Integer socketTimeoutMillis)
A template method to actually create the factory
|
Constructor and Description |
---|
MulticastKeepaliveHeartbeatSender(CacheManager cacheManager,
InetAddress multicastAddress,
Integer multicastPort,
Integer timeToLive,
InetAddress hostAddress)
Constructor.
|
MulticastRMICacheManagerPeerProvider(CacheManager cacheManager,
InetAddress groupMulticastAddress,
Integer groupMulticastPort,
Integer timeToLive,
InetAddress hostAddress)
Creates and starts a multicast peer provider
|
RMICacheManagerPeerListener(String hostName,
Integer port,
Integer remoteObjectPort,
CacheManager cacheManager,
Integer socketTimeoutMillis)
Constructor with full arguments.
|
RMICacheManagerPeerProvider(CacheManager cacheManager)
Constructor
|
Modifier and Type | Method and Description |
---|---|
abstract CacheManagerEventListener |
CacheManagerEventListenerFactory.createCacheManagerEventListener(CacheManager cacheManager,
Properties properties)
Create a
CacheEventListener |
Modifier and Type | Method and Description |
---|---|
void |
ProviderMBeanRegistrationHelper.registerMBean(CacheManager manager,
Properties properties)
Registers mbean for the input cache manager and the session factory name
|
void |
EhcacheHibernateMBeanRegistration.registerMBeanForCacheManager(CacheManager manager,
Properties properties)
Registers MBean for the input manager and session factory properties.
|
void |
EhcacheHibernateMBeanRegistrationImpl.registerMBeanForCacheManager(CacheManager manager,
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 |
Modifier and Type | Method and Description |
---|---|
void |
ManagementServer.register(CacheManager managedResource)
Puts the submitted resource under the purview of this
ManagementServer . |
static void |
ManagementServerLoader.register(CacheManager cacheManager,
String clientUUID,
ManagementRESTServiceConfiguration managementRESTServiceConfiguration)
Register a cacheManager to management rest server.
|
static void |
ManagementService.registerMBeans(CacheManager cacheManager,
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,
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(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,
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,
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 | Method and Description |
---|---|
void |
MBeanRegistrationProvider.initialize(CacheManager cacheManager,
ClusteredInstanceFactory clusteredInstanceFactory)
Initialize MBeanRegistration if necessary for the cacheManager
|
void |
MBeanRegistrationProviderImpl.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) |
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 | Method and Description |
---|---|
QueryManagerBuilder |
QueryManagerBuilder.addAllCachesCurrentlyIn(CacheManager cacheManager)
Adds all
Caches present in a Cache Manager to
the internal state of the query manager. |
Constructor and Description |
---|
TerracottaClient(CacheManager cacheManager,
TerracottaClientConfiguration terracottaClientConfiguration)
Constructor accepting the
CacheManager and the TerracottaClientConfiguration |
Copyright © 2003–2016 Terracotta, Inc.. All rights reserved.