Ehcache Core 2.6.9 API

APIs for Ehcache, an in-process Java cache implementation.

See:
Description

Packages

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.cluster	This package contains the API for accessing the cluster node topology and registering to receive events about changes in the cluster node topology.
net.sf.ehcache.concurrent	This package contains concurrency classes and utilities that are not available in java.util.concurrent.
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	This package contains utility classes encapsulating ideas of Elements and Attributes.
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.blocking	Doug Lea in his book Concurrent Programming in Java talks about concurrency support constructs.
net.sf.ehcache.constructs.classloader	ClassLoader contstructs package
net.sf.ehcache.constructs.nonstop	Ehcache-nonstopcache package
net.sf.ehcache.constructs.nonstop.concurrency	Nonstop feature related to concurrent package
net.sf.ehcache.constructs.nonstop.store	Ehcache-nonstopcache behaviors package
net.sf.ehcache.constructs.nonstop.util	Ehcache-nonstopcache utility package
net.sf.ehcache.constructs.web	This package contains only a ShutdownListener, useful for shutting down CacheManager in web apps.
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.ccs	This package contains EhCache specific CacheConcurrencyStrategy implementations.
net.sf.ehcache.hibernate.management.api	This package contains JMX related interfaces for Hibernate and ehcache statistics
net.sf.ehcache.hibernate.management.impl	This package contains JMX related classes for Hibernate and ehcache statistics
net.sf.ehcache.hibernate.nonstop	This package contains interfaces and classes for Hibernate related to Ehcache's nonstop feature.
net.sf.ehcache.hibernate.regions	This package contains region implementations used in Hibernate 3.3 and higher.
net.sf.ehcache.hibernate.strategy	This package contains EhCache specific AccessStrategy implementations.
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.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.pool	This package contains the interfaces concerning the resource pooling facilities.
net.sf.ehcache.pool.impl	This package contains implementations of the resource pooling interfaces.
net.sf.ehcache.pool.sizeof	This package contains the SizeOf implementations for the pooling in Ehcache.
net.sf.ehcache.pool.sizeof.annotations	This package contains annotations to control SizeOf calculations for the pooling in Ehcache.
net.sf.ehcache.pool.sizeof.filter	This package contains the SizeOf filtering interface and implementations for the pooling in Ehcache.
net.sf.ehcache.search	This package contains classes for ehcache core search API.
net.sf.ehcache.search.aggregator	This package contains classes for search aggregator functionality.
net.sf.ehcache.search.attribute	This package contains classes for ehcache search attributes
net.sf.ehcache.search.expression	This package contains classes for search expression types (ie.
net.sf.ehcache.search.impl	This package contains an implementation for Results.
net.sf.ehcache.statistics	This package contains classes related to LiveCacheStatistics and its implementation.
net.sf.ehcache.statistics.sampled	This package contains classes related to SampledCacheStatistics and its implementation.
net.sf.ehcache.store	Store package.
net.sf.ehcache.store.chm	CHM package.
net.sf.ehcache.store.compound	This package contains the main classes and interfaces for the new fully coherent combination disk and memory store for unclustered Ehcache.
net.sf.ehcache.store.disk	This package contains the disk store.
net.sf.ehcache.store.disk.ods	This package contains the classes managing the on-disk structure of the disk store.
net.sf.ehcache.terracotta	This package contains the Terracotta integration functionalities.
net.sf.ehcache.transaction	This package contains classes for controlling cache operations for transactional use.
net.sf.ehcache.transaction.local	This package contains the local transactions subsystem.
net.sf.ehcache.transaction.manager	This package contains the ehcache lookup interface and implementation for the supported JTA transaction managers.
net.sf.ehcache.transaction.manager.selector	This package contains JTA transaction managers selectors.
net.sf.ehcache.transaction.xa	This package contains the functionality to provide XA support to a transactional Cache.
net.sf.ehcache.transaction.xa.commands	This package contains a representation of the queued commands which can be executed against a XA store.
net.sf.ehcache.transaction.xa.processor	XAResource requests processor.
net.sf.ehcache.util	Util package.
net.sf.ehcache.util.counter	This package contains utility classes for Counter
net.sf.ehcache.util.counter.sampled	This package contains utility classes for SampledCounter's
net.sf.ehcache.util.lang
net.sf.ehcache.util.ratestatistics	Contains rate monitoring statistics objects.
net.sf.ehcache.writer	This package contains the cache writer functionalities.
net.sf.ehcache.writer.writebehind	This package contains the write behind functionalities.
net.sf.ehcache.writer.writebehind.operations	This package contains the operations for the write behind functionalities.
net.sf.ehcache.writer.writethrough	This package contains the write through functionalities.

APIs for Ehcache, an in-process Java cache implementation. These can also be used as interfaces to manage data using BigMemory.

Introduction
============
ehcache is a pure Java, in-process cache with the following features:

   1. Fast.
   2. Simple.
   3. Multiple eviction policies: LRU, LFU and FIFO.
   4. Caches can be in memory or on disk.
   5. Disk Stores can be persistent between VM restarts.
   6. Distributed caching using multicast and RMI, with a pluggable API.
   7. Cache and CacheManager listeners
   8. Supports multiple Caches per CacheManager, and multiple CacheManagers per application.
   9. Acts as a pluggable cache for Hibernate 
   10. Small foot print. Both in terms of size and memory requirements.
   11. Minimal dependencies apart from J2SE.
   12. Fully documented. See the online Documentation and the online JavaDoc.
   13. Comprehensive Test Coverage. See the clover test report.
   14. Available under the Apache 2.0 license. EHCache's copyright and licensing has been reviewed and approved by the Apache Software Foundation, making EHCache suitable for use in Apache projects.
   15. Production tested. EHCache is used on a large and very busy eCommerce site.
   16. Web caching, pull-through caches and other common caching implementations are provided in the ehcache-constructs module.

Java Requirements
=================
ehcache supports 1.6 and 1.7 at runtime. When compiling from source, the build process requires at least JDK1.6.

Dependencies
============
- SL4FJ API and binding (see http://slf4j.org)

Installation
============
Place the ehcache.jar into your classpath. Ensure the required dependencies are in the classpath.

Create an ehcache.xml configuration from the one supplied in the distribution and place it in your classpath.

Documentation
=============
See http://ehcache.org/ for full documentation.

The JavaDoc is in the distribution and also online at http://ehcache.org/