$Id: RELEASE_NOTES.txt,v 1.16 2006/03/01 01:52:03 gregluck Exp $


Release Notes For ehcache 1.6.0

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 RMI, JGroups, JMS and Terracotta, with a pluggable API for more mechanisms.
   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.
   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.
   17. Full JMX monitoring implementation
   18. Complete implementation of the draft JCACHE (JSR107) specification.
   19. Compatible with Google App Engine

Java Requirements
=================

    Ehcache 1.6.0 and above supports Java 1.5 and 1.6 at runtime. Ehcache final releases are compiled with -target 1.5.

    The Ehcache 1.5 branch is being maintained for Java 1.4 users.

Dependencies
============

    None. 

Maven POM snippet
=================

     All Ehcache releases are placed in the central Maven repository.

     The Maven snippet for ehcache core is:

     <dependency>
        <groupId>net.sf.ehcache</groupId>
        <artifactId>ehcache</artifactId>
        <version>1.6.0-beta5</version>
     </dependency>

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.

The ehcache-remote-debugger.jar is a tool to be used for distributed debugging. Do not install it in
your project. See http://ehcache.sourceforge.net/documentation/logging.html for how to use it.


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.

Known Issues
============

1. There are a number of known issues and workarounds for Tomcat. See the Using Ehcache with Tomcat chapter
 in the online documentation.

2. See the FAQ online for a current list.