Ehcache Guide and Reference is available as a book. The price for the high quality bound edition is USD49.95 plus shipping. The price for the downloadable print-ready version is USD37.50. The book has 154 pages.
Many people have asked for a format for the documentation where it can be printed out as a book and even where they can get it. Of course, full documentation in the HTML single page and multi-page versions will always remain available on the site.
Buy it online from Lulu Books.
Ehcache-1.6 development is underway.
1.6 Goals:
Check trunk regularly for updates. For maven users (of which ehcache is one) a SNAPSOT repository has been added. See http://ehcache.sf.net/snapshotrepository
The new edition of the Ehcache Book , has been released on Lulu.com. In particular the book covers the new RESTful and SOAP Cache Server.
It is available in downloadable PDF or print versions.
The standalone server provides a ready to go cache server out of the box, using the WAR from the ehcache-server module. Unix-based and Windows servers are supported.
Start it with java -jar ../lib/ehcache-standalone-server-0.1.jar 8080 ../war or the jsvc wrapper with daemon.sh start .
This is the first version of an ehcache W3C Web Services server, packaged as a WAR. This version is made available for testing. See the documentation .
Two APIs are supported: A soap API specified in EhcacheWebServiceEndpointService.wsdl and a RESTful, resource oriented API. This release provides a feature-complete soap API. The RESTful API is not yet feature complete.
Ehcache 1.5.0 provides a couple of fixes to changes made in beta1. If you are testing 1.5 please use this version.
e.g. java -Dehcache.disk.store.dir=/u01/myapp/diskdir ...
The new version prints a list of caches with replication configured, prints notifications as they happen, and periodically prints the cache name, size and total events received.
Note that the debugger is gaining more attention and is now distributed in its own tar ball. It has also moved to its own pure maven build and has additional testing.
See the changelog for complete details.
Ehcache 1.5.0-beta2 provides a couple of fixes to changes made in beta1. If you are testing 1.5 please use this version.
Ehcache 1.5.0-beta1 provides a host of new features and a few bug fixes. (See the ehcache-1.5.0 final release news item).
Ehcache has been honoured as the February 2008 SourceForge project of the month. See http://sourceforge.net/community/index.php/potm-200802/ .
The version of ehcache is a minor maintenance release. The main reason for the release was to include ehcache-failsafe.xml which was omitted from the public maven repository version. See the changelog for complete details.
The final version of ehcache-1.4.0 is available on sourceforge and the Maven central repository.
This version significantly enrichens the ehcache API and enhances extension of ehcache. The new features are:
This final release follows the second beta release by a month and fixes a few minor issues. See changelog for complete details.
A new Book has been released to coincide with ehcache-1.4.0.
The beta 2 version of ehcache-1.4 is available on sourceforge and the Maven central repository.
The second beta release fixes 10 bugs, most of them in the new features being introduced in 1.4.0, reported by beta testers. See the changelog for complete details.
Ehcache Guide and Reference for the forthcoming 1.4.0 release is available as a book. The price for the high quality bound edition is USD49.95 plus shipping. The price for the downloadable print-ready version is USD37.50. The book has 154 pages.
Many people have asked for a format for the documentation where it can be printed out as a book and even where they can get it. Of course, full documentation in html will always remain available online at http://ehcache.sf.net.
Buy it from the Ehcache Storefront at Lulu Books.
The beta version of ehcache-1.4 is available on sourceforge and the Maven central repository.
This version significantly enrichens the ehcache API and enhances extension of ehcache. The new features are:
There are 5 minor bug fixes in the release. At the time of release there are no open bugs in ehcache.
See the changelog for complete details.
The next major version of ehcache has been released.
This version contains the following major new features over 1.2.4:
In terms of minor features:
The distributed caching feature of ehcache is now in wide-spread use in wide ranging environments. All of this field experience unearthed the need for further documentation, clarificationa and bug fixes, particularly for dirty or mis-configured networks, which have been provided in 1.3. Excellent performance has been reported for clusters with up to 20 nodes.
A new Tomcat chapter in the documentation provides specific information on configuring Tomcat with ehcache.
See the changelog for complete details.
Work on new features will now start on a new 1.4 branch. See the Roadmap for details. 1.3 will be maintained as the new stable branch.
This release fixes two bugs and has some minor changes to support third parties who are making extensions to ehcache. See See the changelog for details. A final release should be out in the next few weeks.
Ehcache has a Maven repository for releases at http://ehcache.sourceforge.net/repository. It is synchronized with the Maven central repository. New releases will now appear in the Maven repository without delay.
At JavaOne, Greg Luck, the maintainer of ehcache, was appointed as co Spec Lead of JSR107, JCACHE.
The expert group has been reenergised and is making progress towards getting a spec done. Everyone is welcome to monitor technical discussion on JCACHE at the new mailing list - jsr107 AT jsr107.dev.java.net.
TS-6175 - Distributed Caching, Using the JCACHE API and ehcache, Including a Case Study was attended by around 1200 people. About 50 people had question. There was so much interest that an impromptu Q&A session was held later that day. It appears that interest in caching and ehcache in particular remain very strong in the Java community.
Ehcache-1.3-beta2 has 7 fixes over beta 1. See the changelog for details.
New features in 1.3 are:
In adding these new packages care has been taken not to disturb the existing packages. Only bug fixes have been applied to those. 8 bug fixes, representing all those reported since 1.2.4 have been fixed. Ehcache has no open bugs or patches at the time of release. See the changelog for details.
For anyone attending JavaOne 2007 at the Moscone Centre in San Francisco, the maintainer of ehcache, Greg Luck, will be presenting a session entitled "Distributed Caching, Using the JCACHE API and ehcache, Including a Case Study". This will be a practical session covering much of the recent features added to ehcache.
This is a candidate for a maintenance release.
It contains four feature and fifteen bug fixes received in the two months since ehcache-1.2.3 was released. See the changelog for details.
Eight of the changes in this release are scalability improvements contributed by users running very large ehcache deployments. The distributed caching changes stem from a user who is using ehcache in a multi-subnet cluster of 20 nodes.
The Caching and Gzip filters in the web package have been updated to work on Glassfish and Tomcat.
The distributed caching functionality in ehcache is now 6 months ago.
The maintainer has now been running ehcache distributed in production for four months without incident.
Ehcache has no open bugs or patches at the time of release.
This is a maintenance release. It contains eight feature requests and 6 bug fixes received in the two months since ehcache-1.2.2 was released. See the changelog for details.
All of the feature changes come from the suggestions of people with practical experience using ehcache-1.2. The changes are all fine tuning of the distributed caching functionality rather than large changes.
The distributed caching functionality was released four months ago. There are many production sites running this now, including that of the maintainers.
One of the more difficult aspects of getting distributed caching going is getting past network configurations that swallow multicast. A tool, ehcache-1.2.3-remote-debugger.jar is now included in the distribution so that distributed traffic can be listened in on.
The number of lines of code in ehcache is now three times bigger than ehcache-1.0. They have increased as the features of ehcache have increased. To complement this increase in complexity, commercial support is now available for ehcache. Contact kluck@gregluck.com for details.
Ehcache had more than 4000 downloads per month for the last three months in a row. This is up from the 1500 downloads per month it was running at for the two years before then.
The result is there is now a much larger user community who use ehcache directly, rather than through one of the popular frameworks. This places new demands on the project but also means that most of the code paths and API are being utilised, leading to fewer undiscovered bugs and a continuing evolution of features.
This is a minor maintenance release to ehcache-1.2.1. It clears all bug reports and feature requests received since ehcache-1.2.1 was released. It also includes the fix in ehcache-1.2.0_02 to reduce memory consumption.
See the release notes and changelog for details .
Contains a fix to quickly hand back memory when spooling to disk. See http://gregluck.com/blog/archives/2006/07/tuning_memory_u.html for details on the effect of this change.
ehcache-1.2.1 is mostly a maintenance release of ehcache. It focuses on simplifying usage of new features and easing the migration path between ehcache-1.1 and ehcache-1.2. While ehcache-1.2 is backward compatible, some typical usage scenarios in Hibernate and Spring are not.
See the separate news item on ehcache-1.2.1RC to get the full picture. Changes above ehcache-1.2.1RC are:
Ehcache-1.2.0-01 is a backport of the thread hardening changes to the 1.2.0 branch. The 1.2.0 release will be supported with backports of other important fixes.
Greg Luck, the maintainer of ehcache, has been added to the JSR-107 expert group. The plan is to add a JSR-107 compatibility API to ehcache. The benefit to users is that they can switch to and from ehcache with almost zero code cost, when using the JSR-107 API.
Enabling changes to the ehcache codebase have been made in the ehcache-1.2.1 branch (released 3 July). Work on the compatibility API will occur in the 1.3 branch.
This is a release candidate for ehcache-1.2.1. There are a few very minor bug fixes in this release. The main focus is to resolve upgrade difficulties with client libraries which expect ehcache CacheManagers to be singletons as they were in ehcache-1.1. In ehcache-1.2 any attempt to have two CacheManagers sharing the same configuration resulted in a CacheException being thrown. The check was made on diskStorePath. In ehcache-1.2.1RC multiple CacheManagers sharing the same ehcache.xml configuration is permitted.
To resolve conflicts with DiskStore paths, the second and subsequent CacheManagers create their data files in a unique subdirectory under the first CacheManager's diskStore path.
The other potential conflict is in CacheManagerPeerListeners. In the default implementation the conflict is with RMI listener ports. To resolve this conflict the second and subsequent CacheManagers use a free port to listen on.
For both, warning messages are logged encouraging clients to migrate over to their own ehcache.xml.
There are also a number of enhancements/new features as follows:
Finally, the ehcache-constructs package has been merged into the ehcache module so that there is only one jar to download and install to get all functionaliy. Ehcache-constructs contains Java EE Caching filters and other useful applied caching solutions.
See the change log for more details.
The plan is to rapidly release ehcache-1.2.1 within a week or so. Please report any issues with ehcache-1.2.1RC promptly. Documentation of the new features will be complete during this time.
Some people have requested a printable manual for ehcache. Please seeEhcacheUserGuide.pdf
After 10 months of development, ehcache-1.2 is released. Thanks to all the developers who contributed to the release through feature requests, bug reports and patches during the beta program.
The 1.2 release of ehcache has many new features including:
At time of release, there are no open bugs against the ehcache-1.2. 21 bugs have been fixed in this release. Most of those were raised against the 1.2 beta releases.
See the changelog for more details on this release.
The roadmap for new development has been updated here .
Released ehcache-1.2rc1 to give testers a chance to test recent fixes and fine tuning before a final release.
At this point all bugs, support requests and feature requests are closed. Final testing is focusing on the distributed caching area.
Following many requests, ehcache no longer requires that Elements contain Serializable keys and values. Ehcache will gracefully degrade for those operations which require Serialization.
In particular the MemoryStore and event listeners can be used with Non Serializable elements.
WARNING error messages are logged when an operation cannot be completed because the key or value is not Serializable.
The ehcache 1.2 series from beta5 is released under the Apache 2.0 license.
This is a bug fix release which fixes all reported issues in the new 1.2 features. Developers should be testing this version.
Ehcache is now on Subversion. See the source repository page for details.
Ehcache has outgrown its old web design. This new one is produced using Maven 2 . Please send any feedback on the new site to the team .
A new mailing list, ehcache-list@lists.sourceforge.net, has been created for ehcache users and developers. Go here to subscribe or to search the archive.
Ehcache-1.2, currently at beta 5, has many new features:
Ehcache-1.2 is mostly backward compatible with ehcache-1.1. Ehcache-1.1 ehcache.xml configurations are compatible. There have been a few small API changes to the ehcache-1.1 API.
See the changelog for more details on the release.
This fixes most reported bugs and has fairly complete documentation.
New features over beta2 are:
This release also contains 5 bug fixes and increased test coverage. This version has been comprehensively tested, but has limited production use.
This will be the last pre release of ehcache-1.2 which adds major features. The focus will now shift to addressing any bugs or issues raised by those using this version. Basic documentation of the new features has been completed. Work will also continue on providing configuration and coding examples to use em. Please promptly report any bugs found.
New features over beta1 are:
This release also contains 5 bug fixes and increased test coverage.
This version has been comprehensively tested, but has limited production use. It is recommended for development usage and testing.
New in this version are two new cache eviction policies: Less Frequently Used (LFU) and First In First Out (FIFO). There are also a few minor bug fixes. Thanks to Surya Suravarapu for work on these new policies.
This version of ehcache should be backwardly compatible with ehcache 1.1 except for a dependency on commons-collections 3.1, up from version 2.1. This version has been comprehensively tested, but has limited production use. It is recommended for development usage only.
A subproject of ehcache, ehcache-constructs builds on top of ehcache to create implementations for common caching patterns. All implementations use ehcache as the backing cache. They also share a common purpose - to create very high performance Java applications. New in this version is a fault-tolerant AsynchronousCommandExecutor, which will asynchronously execute arbitrary commands, optionally retrying on a defined array of Exception types a defined number of times at a defined interval.
This version splits out the constructs package into a separate sub-project. This simplifies ehcache for those using it in Hibernate or directly. It also moves the constructs to a separate jar and release cycle. There is only 1 minor bug fix but then there was only one bug reported.
See the release notes and full changelog here .
A subproject of ehcache, ehcache-constructs builds on top of ehcache to create implementations for common caching patterns. All implementations use ehcache as the backing cache. They also share a common purpose - to create very high performance Java applications.
At present ehcache-constructs contains:
Servlet 2.3 caching filters that cache HTTP/S responses:
See the ehcache-constructs subsite for and overview, documentation, javadoc, clover test coverage and more.
This is a major milestone for ehcache - the 1.0 release. It has several bug fixes and a few important new features. They are:
See the release notes and full changelog here .
This is a large release. It fixes several bugs and adds many new features including:
Blocking, self populating and self populating collections cache implementations are provided. They are useful where the cost of creating a cache entry is high, and you want to make request threads block until the first one creates the entry. While new to ehcache, the package is based on code that has been in production for almost a year, and is now ready for a wider audience.
See the release notes and full changelog here .
Changes include:
Bug fixes.
Bug fixes.
Now supports JDK1.2 and JDK1.3 as well as JKD1.4
