Changes Report

Release History

Version Date Description
1.6.0-snapshot 2008-12-31 1.6.0 Alpha
1.5.0 2008-07-12 1.5.0 Maintenance release
1.5.0-beta2 2008-06-7 Second beta of 1.5.0 Maintenance release
1.5.0-beta1 2008-05-13 Maintenance release
1.4.1 2008-02-21 Maintenance release
1.4.0 2008-1-31 1.4 release
1.4.0-beta2 2008-01-01 1.4.0 beta2 release
1.4.0-beta 2007-08-26 1.4 beta release
1.3.0 2007-06-11 1.3 release
1.3.0-beta3 2007-05-27 Beta 3 for 1.3 release
1.3.0-beta2 2007-5-1 Beta 2 for 1.3 release
1.3-beta1 2007-3-9 Beta for 1.3 release
1.2.4 2006-12-31 Final 1.2.4 release
1.2.4RC 2006-11-26 Minor release
1.2.3 2006-9-2 Maintenance release
1.2.2 2006-7-17 Maintenance release to ehcache-1.2.1
1.2.1 2006-7-2 ehcache-1.2.1
1.2.1RC 2006-6-4 ehcache-1.2.1RC
1.2 2006-4-25 ehcache-1.2. ehcache-1.2 represents the addition of many new features while remaining backward compatible with 1.1.
1.2rc1 2006-4-17 ehcache-1.2 release candidate 1. ehcache-1.2 represents the addition of many new features while remaining backward compatible with 1.1.
1.2beta5 2006-3-26 Covers beta1 - beta 5 releases. ehcache-1.2 represents the addition of many new features while remaining backward compatible with 1.1.
1.1 2004-11-23 Maintenance release
1.0 2004-9-28 Stable release
0.9 2004-7-5 Additional release
0.8 2004-5-15 Additional features
0.7 2004-1-2 Bug fix release
0.6 2003-12-8 Bug fix release
0.5 2003-11-18 Hibernate compatibility release
0.4 2003-11-13 First public release

Get the RSS feed of the last changes

Release 1.6.0-snapshot - 2008-12-31

Type Changes By
nullRemoved commons-collections. The LRUHashMap was only being used by early versions of Terracotta integration and is not longer required to support Terracotta. Greg Luck
Removed dependency on backport concurrent. java.util.concurrency is now used. Fixes 1987750 . Greg Luck
Removed dependency on commons-logging. Ehcache now uses java.util.logging at the request of many users. Greg Luck
Java 1.5 is now the minimum version for ehcache 1.6. Java 1.4 will continue to be supported on the ehcache 1.5 branch. Ehcache can reduce its dependency list for the core and therefore occupy a smaller footprint in new applications. Greg Luck

Release 1.5.0 - 2008-07-12

Type Changes By
Fix loading of net.sf.ehcache.hibernate.EhCacheProvider from multiple class loaders. The insistence that a leading slash be at the front of the "net.sf.ehcache.configurationResourceName" property has been removed. If this fix causes anyone an issue, add the "/" to the front of your path. Fixes 1977481 . Greg Luck
Updated the BlockingCache.get() JavaDoc to clarify the contract when a RuntimeException is thrown. Fixes 1990091 . Greg Luck
Added a more meaningful LOG message when a null element is encountered fro m a replication. The only reason that an element can be null is because a SoftRefernence has been reclaimed by the JVM. The log message recommends either increasing heap or setting -Xms to be the same as -Xmx as the Sun JDK will reclaim SoftReferences in preference to increasing heap. Fixes 2002319 . Greg Luck
The remote debugger has had many improvements. It is now packaged in its own tarball available from the downloads page, and also continues to be published as a maven module. It is not in the core tarball so that more focus can be given to it. Greg Luck

Release 1.5.0-beta2 - 2008-06-7

Type Changes By
Fixes to changes made in 1.5.0-beta1: token replacement in ehcache.xml parsing and Cache.get() not searching the DiskStore. Greg Luck

Release 1.5.0-beta1 - 2008-05-13

Type Changes By
Added JGroups Implementation. Thanks to Pierre Monestie for the patch(es) for this. Though new to the core distribution JGroups replication has been in production use in a large cluster for the last 10 months. Applied through patches 1730405 and 1912931. Fixes 1730405 . Greg Luck
CachingFilter changed to use BufferedOutputStream rather than OutputStream. This is a performance improvement. Thanks to Vitaly Baranovsky for the patch. Fixes 1812267 . Greg Luck
Removed setThreadName usage to increase performance. Fixes 1748591 . Greg Luck
JCache interface improvement. if we want preload for this cache, and we probably don't know all the keys at the system startup time. We may want to have new interface: loadAll() This will not be added to ehcache until it gets added to the JCACHE spec. Fixes 1795131 . Greg Luck
Clarified JavaDoc and behaviour so that Cache.getQuiet does not update Element statistics but also cache statistics. Fixes 1795131 . Greg Luck
Enhanced behaviour of diskPersistent so that it will work for MemoryStore only caches. On shutdown the memory store will be written to disk and on startup loaded up into memory. But DiskStore itself will not be used during cache operation. Fixes 1909427 . Greg Luck
The diskStore element in ehcache.xml is now optional. If all caches use only MemoryStores, then there is no need to worry about configuring diskStore. This will simplify configurations particularly where multiple CacheManagers are being used. If one or more caches requires a DiskStore, and none is configured, java.io.tmpdir will be used and a warning message will be logged to encourage explicity configuration of the diskStore path. Thanks to Robert Watkins for suggesting this one. Fixes 1728061 . Greg Luck
By default RMI will assign a random listener port to a new Remote object which prevents its operation through firewalls. Added a new property remoteListenerPort to RMICacheManagerPeerListenerF actory to enable it to be specified. Fixes 1887683 . Greg Luck
Made ManagementService accessible from IoC containers by providing a constructor. Fixes 1958670 . Greg Luck
Added a new system property expansion token "ehcache.disk.store.dir" to DiskStore configuration which can be used to specify the DiskStore directory on the command line or in an environment variable. e.g. java -Dehcache.disk.store.dir=/u01/myapp/diskdir ... Thanks to Brian Chan and others for suggesting this one. Fixes 1898239 . Greg Luck
Add the ability to specify system property tokens using ${tokenname} in ehcache.xml which are then replaced when the configuration is loaded. Fixes 1743082 . Greg Luck
Updated the remote debugger with enhanced reporting and better documentation (See Logging page in the documentation). 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. Fixes 1912953 . Greg Luck
SimplePageCachingFilter returns same content for GET and HEAD. This one is an edge case that can happen. Thanks to Vitaly Baranovsky for the patch. Fixes 812270 . Greg Luck
Change CachingFilter to use setHeader rather than addHeader which was duplicating some headers. Fixes 1890915 . Greg Luck
Update d the JavaDoc to clarify the meaning of the constant SHORT_DELAY. Fixes 1936731 . Greg Luck
Fixed inefficient shutdown of cache when the cache is not diskPersistent. Fixes 1888993 . Greg Luck
Corrected ehcache.xsd so that minOccurs of cache can be 0. This makes ehcache-default.xml legal. Thanks to Andreas Sahlbach for reporting this. Fixes 1938744 . Greg Luck
Fixed Cache destroy exception where Hibernate and Spring are both shutting down during undeploying application. Fixes 1901094 . Greg Luck

Release 1.4.1 - 2008-02-21

Type Changes By
ehcache-failsafe.xml was not being included in the maven package. Moved it to resources so that now it is. Fixes 1895147 . Greg Luck
JCache.getAll wraps values in Element. One place was missed in the fix for this in 1.4.0. Now all correct. Fixes 1831823 . Greg Luck
Fixed error in Cache.remove/Ehcache.remove JavaDoc Fixes 1887638 . Greg Luck

Release 1.4.0 - 2008-1-31

Type Changes By
Update backport-concurrent version to 3.1. This version is available for all versions of Java including 6. Fixes 1819841 . Greg Luck
Tuned a few unit tests use of Thread.sleep due to the Windows timing service of inaccurate aperture. Some tests that us ed an added 10ms to allow for Windows now allow for 20ms, based on research published in this bug report. Fixes 1880042 . Greg Luck
Removed one last thread renaming method. The others were removed in 1831446. Thanks to Diogo Quintela for pointing this out. Fixes 1880042 . Greg Luck

Release 1.4.0-beta2 - 2008-01-01

Type Changes By
NPE in MulticastKeepaliveHeartbeatReceiver when accessing processingThreadPool during startup. Fixes 1819841 . Greg Luck
RMIAsynchronousCacheReplicator flushReplicationQueue change to speed it up and remove pausing. Thanks to Kyle Sampson for this one. Fixes 1816084 . Greg Luck
RegisteredEventListeners is not thread-safe where listeners are being added and removed during operation. Fixed. Thanks to Geoffrey Arnold for pointing this out. Also removed final from class. Fixes 1811875 . Greg Luck
CacheStatistics causes a NPE if used for fresh caches. Fixed. Fixes 1828351 . Greg Luck
Dropped thread renaming in SelfPopulating cache. A debug feature that has probably outlived its usefulness. Fixes 1831446 . Greg Luck
cache.getAllWithLoader should use a loadAll method for any keys not present in the cache rather than loading individually. This is a performance optimisation. Fixed. Fixes 1831817 . Greg Luck
Division by zero in RMIBootstrapCacheLoader.java where elements are non-null but empty, which causes bootstrap to fail, although gracefully. Fixed. Fixes 1846461 . Greg Luck
Style issue. Abuse of Exceptions. Fixed. Fixes 1831755 . Greg Luck
JCache.getAll wraps values in Element. Fixed. Fixes 1831823 . Greg Luck
Replication Thread of Default Cache not disposed. Fixed. Fixes 1802513 . Greg Luck

Release 1.4.0-beta - 2007-08-26

Type Changes By
Add CacheLoaders to ehcache configuration and core classes. Greg Luck
Add CacheExceptionHandlers. The enable an exception handler to be registered with a cache so that it is called on exception rather than the exception being thrown. Greg Luck
Add CacheExtensions. This is a generic facility which holds a reference to a cache and is bound to the cache lifecycle, making possible a wide variety of extensions to behaviour. Greg Luck
Add a version number to the ehcache jar manifest as is the Apache convention. Fixes 1737269 . Greg Luck
Include all required libraries in the Sourceforge tarball download. Fixes 1752251 . Greg Luck
Updated FAQ and Dependency chapters in the documentation and the Release Notes to point out that backport-concurrent for Java 5 is not compatible with Java 6, but the Java 4 version is. Fixes 1756338 . Greg Luck
LfuMemoryStore did not support Non-Serializable objects. Fixes 1744643 . Greg Luck
Excessive CPU and (debug) logging when multicast send fails. Added a sleep to reduce the log spam when multicast is being blocked by a firewall. Continuous log messages obscure the network configuration issue. Thanks to Ronald Tschal for the bug report and patch. Fixes 1755263 . Greg Luck
NPE during CacheManager shutdown with persistent disk cache only where the maxElementsOnDisk=1. Thanks to James Shaw for the bug report. Fixes 1759740 . Greg Luck
i18n issue in the PageFragmentCachingFilter. Thanks to David Sheldon for the bug report and fix. Fixes 1753349 . Greg Luck
ManualRMICacheManagerPeerProvider.listRemoteCachePeers lists no peers if one node is down. The manually configured cluster should list those peers that are available so that the cluster can continue until the missing node is restored. Fixes 1739612 . Greg Luck

Release 1.3.0 - 2007-06-11

Type Changes By
Where the Hibernate EhCacheProvider or SingletonEhCacheProvider is being used with a configurationResourceName to load an ehcache configuration other than default, when it is not found in the classpath, no warning or other failure occurs. Ehcach e will instead load itself from defaults. Added a warning message to indicate that a configurationResourceName was specified but could not be found. This should simplify debugging. Thanks to Robert Watkins for raising this issue. Fixes 1728071 . Greg Luck
RMIRegistry is now stopped if it was started by ehcache. This fixes a classloader memory leak on redeploy and reload in app servers. Thanks to Stefan Fleiter for supplying a patch. Fixes 1728780 . Greg Luck
Tweak to bootstrap to check for expired elements. It will skip expired elements rather than failing the bootstrap. Thanks to Stefan Fleiter for supplying a patch. Fixes 1728950 . Greg Luck
PropertyUtil.parseProperties using a JDK 1.5+ only feature. This issue was introduced in 1.3.0-beta3. Thanks to Ben Piper for pointing this out. Fixes 1732424 . Greg Luck
DiskStore trace message for put back ups should only log when the DiskStore is backed up. Thanks to Stefan Fleiter for this one. Fixes 1730999 . Greg Luck

Release 1.3.0-beta3 - 2007-05-27

Type Changes By
Add the ability to specify the property separator for the properties element in factory configurations. This is a new attribute propertySeparator that can be used in ehcache.xml configuration files. Greg Luck
Enable the DiskStore to be programmtically pluggable in the Store hierarchy. Thanks to Matt Ma goffin for the patch. Greg Luck
Applied minor patch to Element to allow it to be easily persisted using mechanisms other than Java Serialization. Thanks to Matt Magoffin for the patch. Greg Luck
Problems when peer lookup fails when receiving heartbeats because heartbeat receiving is single-threaded. This issue affects dirty or misconfigured networks or clusters. It hardens ehcache so that valid peers can still form a cluster in the presence of Naming.lookup() problems with one or more peers. Thanks to Daniel Weill and Fredrik Bertilson for reporting this and Daniel for supplying a patch. The patch changes the heartbeat receiving implementation to be multi-threaded so that one bad peer cannot bring the others down. Fixes 1715492 . Greg Luck
Ehcache does asynchronous puts to the DiskStore. In previous version the amount of memory that could be used for spool buffering was unlimited. In very high load situations with limited memory this could cause OutOfMemory erros. This version introduces a diskSpoolBufferSizeMB configured per cache with a default of 30MB. Set this value to control the maximum amount of memory each cache DiskStore spool can consume. The default of 30MB should work well for backward compatibility. If you notice your DiskStore performance is affected negatively, increase diskSpoolBufferSizeMB. Fixes 1720152 . Greg Luck

Release 1.3.0-beta2 - 2007-5-1

Type Changes By
Fix issue reported by Fredrik Bertilsson regarding peers entering and leaving a cluster, where the reentered peer would never get updates. Greg Luck
Fixed RMICachePeer.getElements so that it does not allow null elements. Fixes 1703340 . Greg Luck
DiskStore SpoolThread is too slow under Java 1.6. The Spooling Thread was set to 2, on a scale of 1 to 10 from lowest to highest priority. Under JDK 1.6, this setting did not allocate enough CPU to enable the spool to be cleared in a given situation, whereas under JDK1.5 it did. This seems to be a bug in JDK6. The priority is now set to Thread.NORMAL_PRIORITY, which is 5. Fixes 1681308 . Greg Luck
Distributed cache - flushing replicationQueue on dispose. We should flush the replication queue rather than clear it on dispose. Fixes 1684223 . Greg Luck
Fix clone problem introduced in 1.3-beta. This affects caches created from the default cache. Thanks to Erik Voorbraak for reporting this. Fixes 1704257 . Greg Luck
Add note to sample ehcache.xml and documentation about the reserved cache name "default". Fixes 1694609 . Greg Luck
The shutdown hook is now turned off by default. Set the system property net.sf.ehcache.enableShutdownHook=true to turn it on. Greg Luck
Document known issue with Tomcat. The presence of multiple < Host > entries in Tomcat's server.xml prevents replication from occuring. Thanks to David Patton for reporting this. Fixes 1706854 . Greg Luck
Make clear in the JavaDoc documentation in Cache that RemoteCacheException can be thrown by calls to put, remove and removeAll when the cache replication policy is synchronous and a remote peer is unavailable. Thanks to Christopher G. Stach II for reporting this issue. Fixes 1680964 . Greg Luck

Release 1.3-beta1 - 2007-3-9

Type Changes By
Added a net.sf.ehcache.jcache package, which is an implementation of JSR107, backed by ehcache. Greg Luck
Added a net.sf.ehcache.management package, which contains full JMX instrumentation for ehcache. Greg Luck
Statistics Variables Need to be Longs. Changed internal representation to long in Cache, kept the direct getters for backwards compatible and changed the new Statistics class to be long based. Use getStatistics() to access the longs with out loss of precision. Reapplied. Somehow this got lost from 1.2.4. Fixes 1588796 . Tony Voss
Filter was rethrowing IOException as ServletException. The spec is clear that IOException is thrown as well. Catching these and rethrowing them as ServletException causes these IllegalStateException in Glassfish. Chris Ryan
JBoss, Spr ing and some other applications have shutdown hooks. A race condition existed in CacheManager#shutdown() such that multiple shutdown hook threads could attempt to shutdown the CacheManager at the same time. Added class synchronization to prevent this and also added a check for the system property net.sf.ehcache.disableShutdownHook=true which will disable addition of the shutdown hook. Reported by various people. Note: In ehcache-1.3-beta2 and higher the shutdown hook is off by default. The above property has no effect. Set the system property net.sf.ehcache.enableShutdownHook=true to enable it. Fixes 1616492 . Greg Luck
Element#equals(Object) causes ClassCastException when the comparison object is not an Element. Fixed. Fixes 1618798 . Greg Luck
GzipFilter corrupts UTF-8 encoded non-Latin characters. Fixed. Thanks to Matt Raible and Konstantin Kolinko for the bug report and Kolodin for the patch. This issue also affected the CachingFilter. Fixes 1636876 . Greg Luck
Fix bug in RMIBootstrapCacheLoader.doLoad. If the first element in the remote cache is null, no bootstrapping will take place. Fixed. Thanks to Ben Piper for reporting this one and the fix. Fixes 1664030 . Greg Luck
Fix issue reported by Fredrik Bertilsson regarding peers entering and leaving a cluster, where the reentered peer would never get updates. Greg Luck
Fix bug for the combination of Automatic Peer Discovery and synchronous bootstrapping. Fixes 1661328 . Greg Luck
Removed the JNDI manual listener and peer provider. This was proving difficult to maintain. Custom listeners and providers are pluggable and can be added as an extension to ehcache. Greg Luck

Release 1.2.4 - 2006-12-31

Type Changes By
Consolidate shutdown hooks to one on each CacheManager instance. Greg Luck

Release 1.2.4RC - 2006-11-26

Type Changes By
Dropped support for JDK1.3. Resulting changes are proper chained exceptions, and no longer requiring commons-collections. This enables some simplifications in the code base and eases maintenance. Greg Luck
Added a maxElementsOnDiskStore attribute to cache. This lets disk stores be bounded. ehcacheLFU eviction is used to decide which element to evict. Greg Luck/Jody Brownell
Combined the DiskStore's expiry and spool threads. They were competing for the same locks anyway. This reduces the maximum number of threads used from 2 to 1 per DiskStorwe. Greg Luck/Jody Brownell
Enable the timeToLive to be set on the cacheManagerPeerProviderFactory. This enables the spread of multicast packets to be controlled from a single host to the Internet. The default is 1, which is the same as the Java default so the default behavior will not change for existing users. Fixes 1588976 . Tony Voss
Fix typo in lock timeout log message in BlockingCache. Thanks to Matt Magoffin for reporting this bug. Fixes 1574735 . Greg Luck
Fix issue where it is not possible to specify a DiskStore path consistently on all operating systems. This is a workaround to a JDK bug. Always create paths like "java.io.tmpdir/cache". Any trailing characters to java.io.tmpdir added for windows and solaris will be removed and placed with a single file separator. Fixes 1579761 . Greg Luck
Fixed NullPointerException on Cache.evictExpiredElements() and added some other NPE guards to Cache. Fixes 1563017 . Greg Luck
Synchronous bootstrap and manual peer discovery combination does not work because the first cache to start always fails. This is normal and the CacheManager should cope with it. Added a catch and log a message when this happens. Thanks to Patrick Galley for the bug report. Fixes 1585015 . Greg Luck
ehcache.xsd diskStore path defined as xs:NCName Fixes 1589004 . Greg Luck
Fix documentation error: Ehcache provider package inconsistent Fixes 1589451 . Greg Luck
Fixed NPE when both DiskStore path is not configured and DiskStorePath is not being used. Thanks to mdillon for the patch. This was also reported under the above bug number. Fixes 1593099 . Greg Luck
CachingFilter and its subclasses now work when upstream filters or servlets return 404 or 302, 301. Greg Luck
Fixed rare ConcurrentModificationException in getBoundCachePeers. Thanks to Tony Voss Fixes 1584776 . Greg Luck
Harden heartbeat sender for IOExceptions and large peer sizes. Thanks to Tony Voss for the patch. Fixes 1583996 . Greg Luck
Reduce network utilisation for distributed caching through the optimisation of only doing a Naming.lookup(url) when the url has not been seen before. Fixes 1584041 . Greg Luck
Various fixes to web package to make filters work on Sun Application Server 9 and Tomcat in addition to Orion. Add support for errors and redirects passing through filters. Greg Luck
Multiple multicast packets sends multiple heartbeats Fixes 1592324 . Tony Voss
Infinite recursion in BlockingCache.getKeysNoDuplicateCheck Fixes 1591711 . dguist
Statistics Variables Need to be Longs. Changed internal representation to long in Cache, kept the direct getters for backwards compatible and changed the new Statistics class to be long based. Use getStatistics() to access the longs with out loss of precision. Fixes 1588796 . Tony Voss

Release 1.2.3 - 2006-9-2

Type Changes By
Cache.remove doesn't fire listeners if element didn't exist. This stopped cluster removes from working where the local cache does not have the element cached. Thanks to Elijah Epifanov for reporting this one and arguing the case for this behaviour Fixes 1524597 . Greg Luck
Allow references to ehcache.xsd in ehcache XML files. All of the ehcache.xml files have had the schema reference added. This allows easy validation of ehcache.xml configuration files using tools like Eclipse and IntelliJ. Thanks to Gabriel Klein for suggesting this. Fixes 1540653 . Greg Luck
Added a new property asynchronousReplicationIntervalMillis to the RMICacheReplicator factory configuration to control the interval at which it runs. The default is 1000ms, which is the value it was hardcoded too in earlier versions. Fixes 1540657 . Greg Luck
Added a new notifyRemoveAll cache event notification as requested by users. Called during Ehcache#removeAll() to indicate that the all elements have been removed from the cache in a bulk operation. The usual notifyElementRemoved is not called. This notification exists because clearing a cache is a special case. It is often not practical to serially process notifications where potentially millions of elements have been bulk deleted. Greg Luck
from the cache, but it is different, thus the separate notification. The usual notifyElementRemoved is not called. Greg Luck
Asynchronous replication / soft references. There is a trade off between OutOfMemory risk and replication correctness. Change the RMIAsynchronousCacheReplicator so that Elements are SoftReference, not all EventMessages. The result is that put and update via copy may be SoftReference collected, but remove and update via remove will always go through. Fixes 1523915 . Greg Luck
Change Cache#getQuiet so that cache statistics are not updated. This is a sensible API change and probably always should have worked this way. Greg Luck
Open up some classes by removing final keyword and changing the constructors to public. Greg Luck
Fix isssue where a distributed cache can take up to a minute to shutdown. This issue affected web container and application server shutdowns. The fix is to unbind RMICachePeers before unexporting them. Thanks to Lennard Fuller and Peter Chiang for finding and fixing this hard one. Fixes 1532610 . Greg Luck
Fixed a few broken links and inconsistencies in the documentation. Fixes 1529506 . Greg Luck
Bad dependency scopes in Maven2 POM. Most dependencies are required only at test time. Changed the pom to reflect this. Fixes 1542696 . Greg Luck
Synchronous replicators in a cluster can deadlock trying to replicate to each other. The deadlock gets resolved by a SocketTimeoutException depending on what you set it too. Reduce synchronization around gets, puts and removes so that listener notification is not synchronized, which resolves this problem. Fixes 1540322 . Greg Luck
Fixed a bug where in BlockingCache and SelfPopulatingCache where setTimeoutMillis was set to a non zero value. Fixes 1550043 . Greg Luck
Large TTL values cause expire time to be incorrect in Element. Changed ONE_SECOND from an int to a long which fixes the issue. Fixes 1548314 . Greg Luck

Release 1.2.2 - 2006-7-17

Type Changes By
Added a ShutdownListener which implements ServletContextListener for shutting down all CacheManagers in a web application. Fixes 1521843 . Daniel Wiell
If you put an Element with overridden TTL and TTI values and then replace it with an Element with defaults, the new Element lives forever. putQuiet is not affected by this bug. Thanks to Pete at Goodtech for finding this one. Note that a symptom of this bug for caches that overflow to disk is an endlessly growing .data file for the Cache. Fixes 1516447 . Greg Luck
Reduce the memory used by flushSpool() in DiskStore. See http://gregluck.com/blog/archives/2006/07/tuning_memory_u.html for details. Greg Luck
Cache names with slashes cause problems. Tightened the validation code around setting a cache name. Now throw IllegalArgumentException if a cache name is null or contains '/'. Thanks to Daniel Wiell for repoting this one and suggesting the fix. Fixes 1521699 . Greg Luck
Loading an element from the disk store fails in some circumstances due to classloading issues. This issue was created by a patch to fix 1324221 back in October 2005. Resolved by trying the new way and then, if a ClassNotFoundException is thrown, doing it the old way. Fixes 1517565 . Greg Luck
CachingFilter should not change Thread name. Now sets it back to the original when done. Fixes 1513436 . Greg Luck

Release 1.2.1 - 2006-7-2

Type Changes By
Change Blocking cache to use a lock striping technique for its Mutexes. This limits the number of Mutexes to 100, rather than a number equalling the number of keys, while preserving excellent liveness and safety. Thanks to Olaf Krische for reporting this and Brian Goetz for assisting with a solution. Fixes 1492900 . Greg Luck
Change BlockingCache and SelfPopulatingCache to act as decorators for Ehcache. Remove now redundant BlockingCacheManager and SelfPopulatingCacheManager. Change signatures of these caches from Serializable to Object. This change is not backward compatible but no libraries use these, so developers can change over on their own projects. Greg Luck
This was reported by Victor Volle and is a duplicate of 1492900. Fixed. Fixes 1190614 . Greg Luck
Changing all classloading to the context classloader is sometimes inconvenient. Fallback to ClassLoaderUtil.class.getClassLoader() if Thread.currentThread().getContextClassLoader() fails. Thanks to Robert Watkins for reporting this one. Fixes 1506399 . Greg Luck
Debug messages generate excess String objects. Added logging level guards around about 6 debug log statements. Thanks to Derek Hulley for pointing this one out. Fixes 1508623 . Greg Luck
Harden all ehcache threads so that RuntimeExceptions and Errors do not stop them. This change, on its own, has been backported to a separate release, ehcache-1.2.0_01. Greg Luck
Change spooling mechanism to use less memory, s o as to avoid memory spikes. Greg Luck

Release 1.2.1RC - 2006-6-4

Type Changes By
Added the constructs package which was previously a separate module. The constructs package adds valuable functionality and given that the 1.2 jar size is large, can be added with only a small increase in jar size. Greg Luck
Allow zeroconf of RMICacheManagerPeerListenerFactory. A configuration < cacheManagerPeerListenerFactory class="net.sf.ehcache.distribution.RMICacheManagerPeerListenerFactory"/ > will now work. The listener port will be automatically assigned a free port. Fixes 1483735 . Greg Luck
New SingletonEhCacheProvider for use by Hibernate in situations where code has been written which relies on the singleton behaviour of ehcache-1.1 and earlier. Most code bases using Hibernate should not require this. Greg Luck
Allow cacheEventListenerFactory elements to be added to defaultCache in ehcache.xml. This allows caches created with CacheManager.addCache(String cacheName) to receive events. This can be used for example to set default replication settings in defaultCache. Greg Luck
To complement full support foe default cache (above), added support for programmatic addition of caches which include CacheReplicators. Also support for removal of these caches with CacheManager .remove(String cacheName). Greg Luck
Andy McNutt's JNDI-based manual RMI replication added. See ehcache.xml example for how to use. Greg Luck
Support tomcat 5.5 for the servlet filters. Tomcat integration testing, in addition to the Orion one, is also added to the full JUnit test process. Tomcat relies on Servlet 2.4 dispatcher INCLUDE and FORWARD directives for page fragment caching. Greg Luck
Support runtime setting of individual Element time to lives, time to idles and eternal overrides. If an override is set, the Element expiry ignores the Cache default. Greg Luck
Add a cache bootstrap mechanism. This is used to populate a cache when it is first initialized. An abstract factory, BootstrapCacheLoaderFactory has been defined along with an interface BootstrapCacheLoader. The initial concrete implementations are for RMI, so that a new cache entering a cluster gets bootstrapped from a randomly chosen peer. Greg Luck
Allow CacheManager instances to use the same ehcache.xml configuration. Automatically resolve conflicts for DiskStore and CacheManagerPeerListener. Log a warning that the conflict existed and what was done to resolve it along with a suggestion to either use ehcache in singleton mode or specify separate ehcache.xml configurations for each CacheManager instance. Greg Luck
Theoretically possible NPE if a MulticastRMICacheManagerPeerProvider is started and then stopped before a multicast socket connection can be established. Added guard for NPE. Thanks to Roman Kurmanowytsch for reporting the issue and a fix. Fixes 1480442 . Greg Luck
Add shutdown hook to RMICacheManagerPeerListener so that, even if CacheManager.shutdown() is not called, processes still exit cleanly. This is a bug rather than a feature request because Cache has a shutdown hook to always cleanly shut down disk store, and ehcache should be consistent in supporting shutdown hooks. Fixes 1485765 . Greg Luck
In GzipFilter and CachingFilter Gzipping an empty response body creates 20 byte responses. Fixed so that this situation is detected and a zero bytes gzipped body, with a content length also of 0 is returned. Can occur in 204 and 304 responses. Fixes 1486858 . Greg Luck
Changed localhost lookup to a static in Cache, to avoid a potential bottleneck when creating and destroying large numbers of caches rapidly. Thanks to Derek Hully for the bug report and suggested fix. Fixes 1488853 . Greg Luck

Release 1.2 - 2006-4-25

Type Changes By
Changing the API to Object from Se rializable breaks projects. Leave the existing Serializable API in place and add new constructors and methods for Object. Add getObjectValue and getObjectKey to Element. Fixes 1473833 . Greg Luck
Closing Cache does not remove reference from DiskStore, preventing Garbage Collection of DiskStore and Cache on dispose of a cache. Fixed to set Cache reference to null on dispose. Thanks to Felix Meschberger for the patch. Fixes 1474363 . Greg Luck
Closing Cache does not remove shutdown hook, preventing Garbage Collection of a Cache with a persistent DiskStore on dispose of a cache. Fixed to remove the shutdown thread after dispose. Thanks to Felix Meschberger for the patch. Fixes 1474360 . Greg Luck

Release 1.2rc1 - 2006-4-17

Type Changes By
License updated to Apache 2.0. Greg Luck
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. Greg Luck
Feature Request 1458049 Wrap original exceptions during configuration. Added an intial cause Throwable field to CacheException to facilitate easier reporting without breaking pre JDK1.4 compatibility. Greg Luck
Removed the old Hibernate plugin from the code base. It has been deprecated since the beginning of the 1.2 beta series. The plugin is being actively maintained in the Hibernate project. Any project still using net.sf.ehcache.hibernate.Plugin should change their Hibernate configurations to org.hibernate.cache.EHCacheProvider. Greg Luck
Feature Request 1081071. Added the ability to specify subdirectories under System Property paths. e.g. java.io.tmpdir/one Greg Luck
Feature Request 1025706. Added the ability to specify a system property, net.sf.ehcache.disabled=true, to easily disable ehcache. A disabled cache works fully but discards and Elements added to it. Greg Luck
Add protections to the DiskStore spoolThread against programming errors in Elements that can cause it to die. Secondly, if it does die, disable adding elements to the DiskStore and log an error, so as to gracefully degrade. Fixes 1432458 . Greg Luck
flush() was using up to double the memory used by a MemoryStore during flush() which could cause an OutOfMemory error on shutdown if memory was constrained. flush no longer causes any memory spike. Thanks to Sergey Nekoval for reporting the bug. Fixes 1369073 . Greg Luck

Release 1.2beta5 - 2006-3-26

Type Changes By
Introduced new caching policies in addition to the standard LRU. FIFO and LFU were added. LRU remains the default unless explicitly set in each cache's configuration. Thanks to Surya Suravarapu for working with me on these. The documentation has a new section on caching policies and when to use what. Surya Suravarapu
Introduced CacheManagerEventListener and CacheEventListener interfaces and default implementations. These can be configured in ehcache.xml or set programmatically. Thanks to steve at jofti dot com for help with the specification for these. Greg Luck
After requests from Jo Walnes, Paul Hammant and others, I have added normal instance constructers to CacheManager which do not act as singletons. The factory singleton methods remain for backward compatibility. CacheManager can now be constructed with a Configuration object programmatically. Greg Luck
Since version 1.1, ehcache has had a persistent diskStore, which makes it suitable for storing application state. Added a flush method so that, if t he cache is diskPersistent, it can be programmatically flushed, in addition to the automatic flush which happens at shutdown. Greg Luck
Pluggable Distributed Caching. The default implementation supports cache discovery via multicast or manual configuration. Updates are delivered asynchronously or synchronously via custom RMI connections. Additional discovery or delivery schemes can be plugged in by third parties. Greg Luck
DiskStore is now up to 12 times faster in certain operations and much more scalable. Greg Luck
Significant (up to 7 fold) DiskStore performance increases, after introduction of finer grained threading. Thanks to Robert Watkins for reporting on the performance limits. Greg Luck
Clover test coverage raised to 86%. Greg Luck
Feature Request 431481 Distributed: The ability to notify cache event listeners excluding CacheReplicators Greg Luck
Feature Request 1431393 Events from remote in distributed cache should be received by any non CacheReplicator listeners Greg Luck
Patch 1158788. Fix for dependencies list... MemoryStore.java to remove Apache commons-collections for JDK1.4 users Greg Luck
change default configuration to use context classloader Fixes 1122734 . Greg Luck
Fix for DiskStore to deserialize using Thread.currentThread().getContextClassLoader() Fixes 1324221 . Greg Luck
CacheManager.shutdown now uses a Class rather than an instance lock. Fixes 1261613 . Greg Luck
Configurator gets a file not found when files contain spaces. Fixes 1237017 . Greg Luck
DiskStore degrades under load. Fixes 1332728 . Greg Luck
Change classloader to Thread.currentThread().getContextClassLoader() for ehache.xml. Fixes 1079529 . Greg Luck
DiskStore data file is not deleted when index is corrupt. Fixes 1414674 . Greg Luck
JavaDoc documentation fix for element.getLastAccessTime returns 0 for element just created Fixes 1224325 . Greg Luck
Documentation should advise using the Hibernate supplied plugin rather than the older one in ehcache which is now deprecated. Fixes 1247019 . Greg Luck
Fix bug introduced in 1.2 beta series. Removed Boolean.parseBoolean and java.util.Queue which were introduced in the JDK1.5 API to preserve backward compatibility. Fixes . Greg Luck
F ix bug introduced in 1.2 beta series. Changed ant script to avoid compiling with clover in dists Fixes . Greg Luck
Fix bug introduced in 1.2 beta series. Cannot load configuration from jar (or any non-file URL). Fixes 1410374 . Greg Luck
Fix bug introduced in 1.2 beta series. NPE on RMICacheManagerPeerProviderFactory when rmiUrls not specified. Now throws a meaningful CacheException. Fixes 1432074 . Greg Luck
Fix bug introduced in 1.2 beta series. Deadlock on deserialization of a cache entry. Thanks to Felix Meschberger for reporting the bug and uploading a patch. Fixes 1445694 . Greg Luck
Fix bug introduced in 1.2 beta series. Caches created with Cache.addCache(String) share a RegisteredEventListeners instance. Thanks to Olaf Ontaine for for reporting the bug and showing how it happens. Fixes 1457268 . Greg Luck
Fix bug introduced in 1.2 beta series. RMIAsynchronousCacheReplicator mishandling non-copy updates. Thanks to Randy Puro for a patch. Fixes 1451780 . Greg Luck

Release 1.1 - 2004-11-23

Type Changes By
Split out the entire constructs package. These are now in a new subproject: ehcache-constructs, which has been released. See http://ehcache.sf.net/ehcache-constructs for more details. Greg Luck
removed the dependency on Doug Lea's concurrency library. Greg Luck
Add new documentation on cache configuration and hibernate performance tuning. Greg Luck
Extra check to make sure that we always close persistent disk store's FileInputStream in the rare case where the ObjectInputStream is null. Fixes 1063908 . Greg Luck

Release 1.0 - 2004-9-28

Type Changes By
Added SelfPopulatingCacheManager Greg Luck
Added a new diskExpiryThreadIntervalSeconds configuration option to ehcache.xml, to allow tuning of the expiry thread per cache. Greg Luck
Added a new diskPersistent feature and configuration option. diskPersistent makes disk stores persistent between CacheManager and JVM restarts. It enables very long held caches to be configured, useful for very expensive cache entries that are long lives, such as mapping geocodes. Greg Luck
Expiry Thread now has a default time of 2 minutes, not 25. Fixes . Greg Luck
Expiry Thread now dies immediately on DiskStore disposal. Fixes . Greg Luck
cache.calculateInMemorySize() now returns a non-zero value Fixes . Greg Luck
Bug 1025130 - Null Pointer Exception when no default cache configured. Now we throw a CacheException with a meaningful message. Fixes . Greg Luck
Bug 1025128 IBM Websphere alway requires commons-collection.jar, even though it is never used. Updated requirements to note this. Fixes . Greg Luck
Patch 1030960. JDK1.4 and higher now chain exception thrown from SelfPopulatingCache. Fixes . Greg Luck
1033061 Fix to Thread naming in SelfPopulatingCache so that the old name is always put back. Fixes . Greg Luck
1003659 build script unfriendly to IDE: IDE builds should now work. Fixes . Greg Luck

Release 0.9 - 2004-7-5

Type Changes By
ehcache.xml cache definitions can now omit timeToIdle and/or timeToLive, which are now optional attributes. This will make cache config easier to read for eternal caches. Either omitting the attributes or setting them to 0 causes them not to be considered when calculating expiry. Earlier versions of ehcache would have immediately expired all elements if either attribute was set to 0, so this change should not break any existing code. Greg Luck
Added getQuiet and putQuiet methods to Cache. These methods are the same as ge t and put but do not affect statistics. Greg Luck
Implemented an Element clone method. Greg Luck
Added calculateInMemorySize() method to Cache to measure the approximate size of a cache's memory footprint. Greg Luck
Increased Clover test coverage to above 80%. Greg Luck
Added many new tests for idle expiry. Greg Luck
Added tests for the new constructs package. These tests demonstrate concurrency performance differences between blocking cache designs based on notify/notifyAll and Doug Lea's concurrency package. Greg Luck
Test new xml format scenarios for eternal, time to idle and time to live Greg Luck
Started adding performance tests to ensure there are no regressions over time. Greg Luck
Added a new constructs package. There are blocking, self populating and self populating collections caches. These are all pull-through caches. They are useful where the cost of creating an entry is high. Details follow: BlockingCache - a cache which blocks subsequent threads until the first read thread populates a cache entry

SelfPopulatingCache - a read-through cache. A cache that populates elements as they are requested without requiring the caller to know how the entries are populated. It also enables refreshes of cache entries without blocking reads on the same entries.

SelfPopulatingCollectionsCache - a SelfPopulatingCache that adds threading safety where it is known in advance that all entries will be collections.

The package is useful for, inter alia, :

- Web Page caches
- Search Engine caches


See the tests for examples of how to use this package.

This package requires Doug Lea's concurrency library. A copy is provided in the tools directory when you check out the project by SVN. Or, you can get it from http://gee.cs.oswego.edu/dl/cpj/ Note that if you are not using the constructs package, you do not need the concurrency library.		 Greg Luck
JavaDoc fixups Fixes . Greg Luck
Fixed time to idle which was not expiring elements after the idle time had expired. This feature did not seem to be getting used. It is now useable. Fixed the test which was also broken Fixes . Greg Luck
Fixed bugs with getSize and getKeys, which were not checking for duplicate keys between the memory and disk stores. Fixes . Greg Luck

Release 0.8 - 2004-5-15

Type Changes By
Investigated a Hibernate SessionFactory bug and clarified it was not a Hibernate bug. Added test. Greg Luck
Investigated a cache size possible bug and clarified it is not in EHCache. Added test. Greg Luck
Added Clover test coverage reporting. Clover instrumentation is not included in release jars. Greg Luck
Updated Hibernate testing to version 2.1.1 Greg Luck
Modified the Apache license at the request of the Apache Cocoon project. Greg Luck
Fixed a very rare null pointer exception, when retrieving a cache entry. Fixes . Greg Luck

Release 0.7 - 2004-1-2

Type Changes By
Cache Configuration Fixed null pointer exception where the disk store path was not specified when use disk store is set to false Fixes . Greg Luck
JDK1.3 Compatibility Replaced JDK1.4 Exception constructors with simple message constructors compatible with JDK1.2 and 1.3 Fixes . Greg Luck
Problem with Element expiry Fixed bug where expiry checking on get was calling remove with the element rather than the key. Fixes . Greg Luck
Expire thread should not run if the cache is not active Changed the expire t hread to while(active) Fixes . Greg Luck
Expiry thread unnecessarily being created for eternal caches Skipped creating the expiry thread if caches are eternal. Fixes . Greg Luck

Release 0.6 - 2003-12-8

Type Changes By
Remove SoftReferences SoftReferences for cache element values has been replaced with standard references. The JDK 1.4.2 JVM was found to remove SoftReferences in normal operation, rather than the expected behaviour of use only to avoid memory exhaustion. Caches will now behave deterministically. Element values will only be removed when the element is garbage collected. Greg Luck
Hibernate Cache Provider. Fixed bug where incompatible timestamps were generated Fixes . Greg Luck
Time to Idle" documentation bug. Fixes . Greg Luck
Fixed documentation bug in ehcache.xml and ehcache-failsafe.xml where "Time to Live" was incorrectly referred to as "Time to Idle" Fixes . Greg Luck

Release 0.5 - 2003-11-18

Type Changes By
Changed from JDK1.4 Logging to Commons Logging. This is to permit JDK1.2 and JDK1.3 to use EHCache. Greg Luck
Added Apache Commons Collec tions LRUMap as an alternative backing Map for the MemoryStore. The java.util.LinkedHashMap has been retained and is used automatically for JDK1.4 and higher. Greg Luck
Added LICENSE.txt to the jar in the distribution Greg Luck
Don't create a Disk Store when overflowToDisk="false" is set in ehcache.xml Fixes . Greg Luck
toString() methods now report on all fields Fixes . Greg Luck
Fixed documentation bug in ehcache.xml and ehcache-failsafe.xml where "Time to Live" was incorrectly referred to as "Time to Idle" Fixes . Greg Luck

Release 0.4 - 2003-11-13

Type Changes By
Initial version, originally based on a fork from JCS plus donated patches. Greg Luck