Ehcache Core 2.0.0 API

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

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.constructs.blocking	Doug Lea in his book Concurrent Programming in Java talks about concurrency support constructs.
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.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.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.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.manager	This package temporarily contains Bitronix stuff.
net.sf.ehcache.transaction.manager.btm	This package contains the Adapter classes for the Bitronix Txn manager for XA support.
net.sf.ehcache.transaction.xa	This package contains the functionality to provide XA support to a transactional Cache.
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.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.

  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 3.1, 3 and 2.1.
   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 1.1 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.3, 1.4, 1.5 and 1.6 at runtime. When compiling from source, the build process requires at least JDK1.5.

ehcache does not work with JDK1.1 and is not tested on JDK1.2.

Dependencies
============
For JDK1.4, ehcache requires commons-logging from Apache's Jakarta project.

For JDK 1.3, ehcache requires:

- Apache Jakarta's commons-collections, version 2.1.1
- Apache xerces (xml-apis.jar and xercesImpl.jar), version 2.5

All three dependencies are also Hibernate dependencies, so if you are using ehcache as a Hibernate plugin, dependency requirements are met.

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.sourceforge.net/documentation for full documentation.

The JavaDoc is in the distribution and also online at http://ehcache.sourceforge.net/javadoc.