Uses of Interface
net.sf.ehcache.Ehcache

Packages that use Ehcache

net.sf.ehcache	This package contains the public API for using ehcache.
net.sf.ehcache.bootstrap	This package contains the bootstrap cache loader interface and abstract factory.
net.sf.ehcache.config	This package contains the cache configuration code.
net.sf.ehcache.constructs.blocking	Doug Lea in his book Concurrent Programming in Java talks about concurrency support constructs.
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.exceptionhandler	This package is for exception handling.
net.sf.ehcache.extension	This package contains interfaces and classes for the cache extension mechanism.
net.sf.ehcache.hibernate	This package contains interfaces and classes for Hibernate3.1 and higher.
net.sf.ehcache.hibernate.regions	This package contains region implementations used in Hibernate 3.3 and higher.
net.sf.ehcache.loader	This package contains a cache loaders and associated factories.
net.sf.ehcache.management	This package contains JMX MBeans and implementations for management of ehcache.
net.sf.ehcache.management.sampled	This package contains classes related to MBeans with Sampled Statistics.
net.sf.ehcache.statistics	This package contains classes related to LiveCacheStatistics and its implementation.
net.sf.ehcache.store	Store package.
net.sf.ehcache.terracotta	This package contains the Terracotta integration functionalities.
net.sf.ehcache.transaction.xa	This package contains the functionality to provide XA support to a transactional Cache.
net.sf.ehcache.writer	This package contains the cache writer functionalities.

Uses of Ehcache in net.sf.ehcache

Classes in net.sf.ehcache that implement Ehcache

class

Cache Cache is the central class in ehcache.

Methods in net.sf.ehcache that return Ehcache

Ehcache	Statistics.getAssociatedCache()
Ehcache	CacheManager.getEhcache(java.lang.String name) Gets an Ehcache

Methods in net.sf.ehcache with parameters of type Ehcache

void	CacheManager.addCache(Ehcache cache) Adds an Ehcache to the CacheManager.
CacheEventListener	CacheManager.createTerracottaEventReplicator(Ehcache cache) Create/access the appropriate clustered cache event replicator for the given cache
Store	CacheManager.createTerracottaStore(Ehcache cache) Create/access the appropriate terracotta clustered store for the given cache
WriteBehind	CacheManager.createTerracottaWriteBehind(Ehcache cache) Create/access the appropriate clustered write behind queue for the given cache
void	CacheManager.replaceCacheWithDecoratedCache(Ehcache ehcache, Ehcache decoratedCache) Replaces in the map of Caches managed by this CacheManager an Ehcache with a decorated version of the same Ehcache.

Constructors in net.sf.ehcache with parameters of type Ehcache

Statistics(Ehcache cache, int statisticsAccuracy, long cacheHits, long onDiskHits, long inMemoryHits, long misses, long size, float averageGetTime, long evictionCount, long memoryStoreSize, long diskStoreSize)
Creates a new statistics object, associated with a Cache

Uses of Ehcache in net.sf.ehcache.bootstrap

Methods in net.sf.ehcache.bootstrap with parameters of type Ehcache

void	BootstrapCacheLoader.load(Ehcache cache) Instructs the loader to load the given cache

Uses of Ehcache in net.sf.ehcache.config

Methods in net.sf.ehcache.config that return Ehcache

Ehcache

ConfigurationHelper.createDefaultCache()

Uses of Ehcache in net.sf.ehcache.constructs.blocking

Classes in net.sf.ehcache.constructs.blocking that implement Ehcache

class	BlockingCache A blocking decorator for an Ehcache, backed by a Ehcache.
class	SelfPopulatingCache A selfpopulating decorator for Ehcache that creates entries on demand.
class	UpdatingSelfPopulatingCache A Cache backed cache that creates entries on demand.

Fields in net.sf.ehcache.constructs.blocking declared as Ehcache

protected Ehcache

BlockingCache.cache The backing Cache

Methods in net.sf.ehcache.constructs.blocking that return Ehcache

protected Ehcache

BlockingCache.getCache() Retrieve the EHCache backing cache

Methods in net.sf.ehcache.constructs.blocking with parameters of type Ehcache

protected void	SelfPopulatingCache.refreshElement(Element element, Ehcache backingCache) Refresh a single element.
protected Element	SelfPopulatingCache.refreshElement(Element element, Ehcache backingCache, boolean quiet) Refresh a single element.

Constructors in net.sf.ehcache.constructs.blocking with parameters of type Ehcache

BlockingCache(Ehcache cache)
Creates a BlockingCache which decorates the supplied cache.

BlockingCache(Ehcache cache, int numberOfStripes)
Creates a BlockingCache which decorates the supplied cache.

SelfPopulatingCache(Ehcache cache, CacheEntryFactory factory)
Creates a SelfPopulatingCache.

UpdatingSelfPopulatingCache(Ehcache cache, UpdatingCacheEntryFactory factory)
Creates a SelfPopulatingCache.

Uses of Ehcache in net.sf.ehcache.distribution

Methods in net.sf.ehcache.distribution with parameters of type Ehcache

protected java.util.List	RMIBootstrapCacheLoader.acquireCachePeers(Ehcache cache) Acquires the cache peers for this cache.
void	RMIBootstrapCacheLoader.doLoad(Ehcache cache) Bootstraps the cache from a random CachePeer.
protected void	RMIBootstrapCacheLoader.fetchAndPutElements(Ehcache cache, java.util.List requestChunk, CachePeer cachePeer) Fetches a chunk of elements from a remote cache peer
protected boolean	RMICacheManagerPeerListener.isDistributed(Ehcache cache) Determine if the given cache is distributed.
java.util.List	ManualRMICacheManagerPeerProvider.listRemoteCachePeers(Ehcache cache)
java.util.List	CacheManagerPeerProvider.listRemoteCachePeers(Ehcache cache)
java.util.List	MulticastRMICacheManagerPeerProvider.listRemoteCachePeers(Ehcache cache)
abstract java.util.List	RMICacheManagerPeerProvider.listRemoteCachePeers(Ehcache cache)
protected java.util.List	RMIBootstrapCacheLoader.listRemoteCachePeers(Ehcache cache) Package protected List of cache peers
void	RMIBootstrapCacheLoader.load(Ehcache cache) Bootstraps the cache from a random CachePeer.
void	RMISynchronousCacheReplicator.notifyElementEvicted(Ehcache cache, Element element) Called immediately after an element is evicted from the cache.
void	RMISynchronousCacheReplicator.notifyElementExpired(Ehcache cache, Element element) Called immediately after an element is found to be expired.
void	RMISynchronousCacheReplicator.notifyElementPut(Ehcache cache, Element element) Called immediately after an element has been put into the cache.
void	RMIAsynchronousCacheReplicator.notifyElementPut(Ehcache cache, Element element) Called immediately after an element has been put into the cache.
void	RMISynchronousCacheReplicator.notifyElementRemoved(Ehcache cache, Element element) Called immediately after an attempt to remove an element.
void	RMIAsynchronousCacheReplicator.notifyElementRemoved(Ehcache cache, Element element) Called immediately after an attempt to remove an element.
void	RMISynchronousCacheReplicator.notifyElementUpdated(Ehcache cache, Element element) Called immediately after an element has been put into the cache and the element already existed in the cache.
void	RMIAsynchronousCacheReplicator.notifyElementUpdated(Ehcache cache, Element element) Called immediately after an element has been put into the cache and the element already existed in the cache.
void	RMISynchronousCacheReplicator.notifyRemoveAll(Ehcache cache) Called during removeAll() to indicate that the all elements have been removed from the cache in a bulk operation.
void	RMIAsynchronousCacheReplicator.notifyRemoveAll(Ehcache cache) Called during removeAll() to indicate that the all elements have been removed from the cache in a bulk operation.
protected static void	RMISynchronousCacheReplicator.replicatePutNotification(Ehcache cache, Element element) Does the actual RMI remote call.
protected static void	RMISynchronousCacheReplicator.replicateRemovalNotification(Ehcache cache, java.io.Serializable key) Does the actual RMI remote call.
protected void	RMISynchronousCacheReplicator.replicateRemoveAllNotification(Ehcache cache) Does the actual RMI remote call.

Constructors in net.sf.ehcache.distribution with parameters of type Ehcache

RMICachePeer(Ehcache cache, java.lang.String hostName, java.lang.Integer rmiRegistryPort, java.lang.Integer remoteObjectPort, java.lang.Integer socketTimeoutMillis)
Construct a new remote peer.

Uses of Ehcache in net.sf.ehcache.event

Methods in net.sf.ehcache.event with parameters of type Ehcache

void	TerracottaCacheEventReplication.notifyElementEvicted(Ehcache cache, Element element) Called immediately after an element is evicted from the cache.
void	CacheEventListener.notifyElementEvicted(Ehcache cache, Element element) Called immediately after an element is evicted from the cache.
void	TerracottaCacheEventReplication.notifyElementExpired(Ehcache cache, Element element) Called immediately after an element is found to be expired.
void	CacheEventListener.notifyElementExpired(Ehcache cache, Element element) Called immediately after an element is found to be expired.
void	TerracottaCacheEventReplication.notifyElementPut(Ehcache cache, Element element) Called immediately after an element has been put into the cache.
void	CacheEventListener.notifyElementPut(Ehcache cache, Element element) Called immediately after an element has been put into the cache.
void	TerracottaCacheEventReplication.notifyElementRemoved(Ehcache cache, Element element) Called immediately after an attempt to remove an element.
void	CacheEventListener.notifyElementRemoved(Ehcache cache, Element element) Called immediately after an attempt to remove an element.
void	TerracottaCacheEventReplication.notifyElementUpdated(Ehcache cache, Element element) Called immediately after an element has been put into the cache and the element already existed in the cache.
void	CacheEventListener.notifyElementUpdated(Ehcache cache, Element element) Called immediately after an element has been put into the cache and the element already existed in the cache.
void	TerracottaCacheEventReplication.notifyRemoveAll(Ehcache cache) Called during removeAll() to indicate that the all elements have been removed from the cache in a bulk operation.
void	CacheEventListener.notifyRemoveAll(Ehcache cache) Called during removeAll() to indicate that the all elements have been removed from the cache in a bulk operation.

Constructors in net.sf.ehcache.event with parameters of type Ehcache

RegisteredEventListeners(Ehcache cache)
Constructs a new notification service

Uses of Ehcache in net.sf.ehcache.exceptionhandler

Methods in net.sf.ehcache.exceptionhandler that return Ehcache

static Ehcache

ExceptionHandlingDynamicCacheProxy.createProxy(Ehcache ehcache) A simple factory method to hide the messiness of creating the proxy from clients.

Methods in net.sf.ehcache.exceptionhandler with parameters of type Ehcache

static Ehcache	ExceptionHandlingDynamicCacheProxy.createProxy(Ehcache ehcache) A simple factory method to hide the messiness of creating the proxy from clients.
void	CacheExceptionHandler.onException(Ehcache ehcache, java.lang.Object key, java.lang.Exception exception) Called if an Exception occurs in a Cache method.

Constructors in net.sf.ehcache.exceptionhandler with parameters of type Ehcache

ExceptionHandlingDynamicCacheProxy(Ehcache ehcache)
Constructor: Use with something like:

Uses of Ehcache in net.sf.ehcache.extension

Methods in net.sf.ehcache.extension with parameters of type Ehcache

CacheExtension	CacheExtension.clone(Ehcache cache) Creates a clone of this extension.
abstract CacheExtension	CacheExtensionFactory.createCacheExtension(Ehcache cache, java.util.Properties properties)

Uses of Ehcache in net.sf.ehcache.hibernate

Constructors in net.sf.ehcache.hibernate with parameters of type Ehcache

EhCache(Ehcache cache)
Deprecated. Creates a new Hibernate pluggable cache by name.

Uses of Ehcache in net.sf.ehcache.hibernate.regions

Fields in net.sf.ehcache.hibernate.regions declared as Ehcache

protected Ehcache

EhcacheDataRegion.cache Ehcache instance backing this Hibernate data region.

Methods in net.sf.ehcache.hibernate.regions that return Ehcache

Ehcache

EhcacheDataRegion.getEhcache() Return the Ehcache instance backing this Hibernate data region.

Constructors in net.sf.ehcache.hibernate.regions with parameters of type Ehcache

EhcacheCollectionRegion(Ehcache underlyingCache, Settings settings, CacheDataDescription metadata, java.util.Properties properties)
Constructs an EhcacheCollectionRegion around the given underlying cache.

EhcacheEntityRegion(Ehcache underlyingCache, Settings settings, CacheDataDescription metadata, java.util.Properties properties)
Constructs an EhcacheEntityRegion around the given underlying cache.

EhcacheQueryResultsRegion(Ehcache underlyingCache, java.util.Properties properties)
Constructs an EhcacheQueryResultsRegion around the given underlying cache.

EhcacheTimestampsRegion(Ehcache underlyingCache, java.util.Properties properties)
Constructs an EhcacheTimestampsRegion around the given underlying cache.

Uses of Ehcache in net.sf.ehcache.loader

Methods in net.sf.ehcache.loader with parameters of type Ehcache

CacheLoader	CacheLoader.clone(Ehcache cache) Creates a clone of this extension.
abstract CacheLoader	CacheLoaderFactory.createCacheLoader(Ehcache cache, java.util.Properties properties) Creates a CacheLoader using the Ehcache configuration mechanism at the time the associated cache is created.

Uses of Ehcache in net.sf.ehcache.management

Methods in net.sf.ehcache.management that return Ehcache

Ehcache

CacheStatistics.getEhcache() Return the backing cache.

Constructors in net.sf.ehcache.management with parameters of type Ehcache

Cache(Ehcache cache)
A constructor for JCache.

CacheConfiguration(Ehcache cache)
Constructs using a backing CacheConfiguration

CacheStatistics(Ehcache ehcache)
Constructs an object from an ehcache statistics object

Uses of Ehcache in net.sf.ehcache.management.sampled

Constructors in net.sf.ehcache.management.sampled with parameters of type Ehcache

SampledCache(Ehcache cache)
Constructor accepting the backing Ehcache

Uses of Ehcache in net.sf.ehcache.statistics

Methods in net.sf.ehcache.statistics with parameters of type Ehcache

void	NullLiveCacheStatisticsData.notifyElementEvicted(Ehcache cache, Element element) Called immediately after an element is evicted from the cache.
void	LiveCacheStatisticsWrapper.notifyElementEvicted(Ehcache cache, Element element) Called immediately after an element is evicted from the cache.
void	LiveCacheStatisticsImpl.notifyElementEvicted(Ehcache cache, Element element) Called immediately after an element is evicted from the cache.
void	NullLiveCacheStatisticsData.notifyElementExpired(Ehcache cache, Element element) Called immediately after an element is found to be expired.
void	LiveCacheStatisticsWrapper.notifyElementExpired(Ehcache cache, Element element) Called immediately after an element is found to be expired.
void	LiveCacheStatisticsImpl.notifyElementExpired(Ehcache cache, Element element) Called immediately after an element is found to be expired.
void	NullLiveCacheStatisticsData.notifyElementPut(Ehcache cache, Element element) Called immediately after an element has been put into the cache.
void	LiveCacheStatisticsWrapper.notifyElementPut(Ehcache cache, Element element) Called immediately after an element has been put into the cache.
void	LiveCacheStatisticsImpl.notifyElementPut(Ehcache cache, Element element) Called immediately after an element has been put into the cache.
void	NullLiveCacheStatisticsData.notifyElementRemoved(Ehcache cache, Element element) Called immediately after an attempt to remove an element.
void	LiveCacheStatisticsWrapper.notifyElementRemoved(Ehcache cache, Element element) Called immediately after an attempt to remove an element.
void	LiveCacheStatisticsImpl.notifyElementRemoved(Ehcache cache, Element element) Called immediately after an attempt to remove an element.
void	NullLiveCacheStatisticsData.notifyElementUpdated(Ehcache cache, Element element) Called immediately after an element has been put into the cache and the element already existed in the cache.
void	LiveCacheStatisticsWrapper.notifyElementUpdated(Ehcache cache, Element element) Called immediately after an element has been put into the cache and the element already existed in the cache.
void	LiveCacheStatisticsImpl.notifyElementUpdated(Ehcache cache, Element element) Called immediately after an element has been put into the cache and the element already existed in the cache.
void	NullLiveCacheStatisticsData.notifyRemoveAll(Ehcache cache) Called during removeAll() to indicate that the all elements have been removed from the cache in a bulk operation.
void	LiveCacheStatisticsWrapper.notifyRemoveAll(Ehcache cache) Called during removeAll() to indicate that the all elements have been removed from the cache in a bulk operation.
void	LiveCacheStatisticsImpl.notifyRemoveAll(Ehcache cache) Called during removeAll() to indicate that the all elements have been removed from the cache in a bulk operation.

Constructors in net.sf.ehcache.statistics with parameters of type Ehcache

LiveCacheStatisticsImpl(Ehcache cache)
Constructor that accepts the backing Ehcache, needed for LiveCacheStatisticsImpl.getSize()

LiveCacheStatisticsWrapper(Ehcache cache)
Constructor accepting the backing cache.

Uses of Ehcache in net.sf.ehcache.store

Fields in net.sf.ehcache.store declared as Ehcache

protected Ehcache	LruMemoryStore.cache The cache this store is associated with.
protected Ehcache	MemoryStore.cache The cache this store is associated with.

Methods in net.sf.ehcache.store with parameters of type Ehcache

static MemoryStore

MemoryStore.create(Ehcache cache, Store diskStore) A factory method to create a MemoryStore.

Constructors in net.sf.ehcache.store with parameters of type Ehcache

DiskStore(Ehcache cache, java.lang.String diskPath)
Creates a disk store.

LruMemoryStore(Ehcache cache, Store diskStore)
Constructor for the LruMemoryStore object The backing LinkedHashMap is created with LRU by access order.

MemoryStore(Ehcache cache, Store diskStore)
Constructs things that all MemoryStores have in common.

Uses of Ehcache in net.sf.ehcache.terracotta

Methods in net.sf.ehcache.terracotta with parameters of type Ehcache

CacheEventListener	ClusteredInstanceFactory.createEventReplicator(Ehcache cache) Create a replicator for the cache events of a given cache
Store	ClusteredInstanceFactory.createStore(Ehcache cache) Create a Store instance for the given cache
WriteBehind	ClusteredInstanceFactory.createWriteBehind(Ehcache cache) Create an WriteBehind instance for the given cache
EhcacheXAStore	ClusteredInstanceFactory.createXAStore(Ehcache cache, Store store)

Uses of Ehcache in net.sf.ehcache.transaction.xa

Constructors in net.sf.ehcache.transaction.xa with parameters of type Ehcache

EhcacheXAResourceImpl(Ehcache cache, TransactionManager txnManager, EhcacheXAStore ehcacheXAStore)
Constructor

Uses of Ehcache in net.sf.ehcache.writer

Methods in net.sf.ehcache.writer with parameters of type Ehcache

CacheWriter	AbstractCacheWriter.clone(Ehcache cache) Creates a clone of this writer.
CacheWriter	CacheWriter.clone(Ehcache cache) Creates a clone of this writer.
abstract CacheWriter	CacheWriterFactory.createCacheWriter(Ehcache cache, java.util.Properties properties) Creates a CacheWriter using the Ehcache configuration mechanism at the time the associated cache is created.