Quick Start

 

Products & Services

 

Training Dates

US - San Francisco
Apr 29-30, 2010
Jun 28-29, 2010
Oct 6-7, 2010
Nov 11-12, 2010
Dec 2-3, 2010
Feb 4-5, 2011

India - Delhi
Feb 4-5, 2010
June 17-18, 2010
Dec 2-3, 2010

See training details.

 

Blogs & Tweets

Changes Report

Release History

Version Date Description
2.0.0 2010-3-4 Major release with new features
2.0.0-beta 2010-1-29 Major release with new features
1.7.2 2010-1-11 Maintenance and bug fixes
1.7.1 2009-11-30 Maintenance and enablement of modularisation
1.7.0 2009-10-5 This is a beta release of Ehcache 1.7.
1.6.2 2009-8-23 This is a maintenance release to Ehcache 1.6.0
1.6.1 2009-7-27 This is a maintenance release to Ehcache 1.6.0.
1.6.0 2009-6-17 This release introduces a new high performance cache core, which is two orders of magnitude faster.
1.6.0-rc1 2009-6-12 This release introduces a new high performance cache core, which is two orders of magnitude faster.
1.6.0-beta5 2009-5-10 This release introduces new high perforamnce cache core, which is two orders of magnitude faster.
1.6.0-beta4 2009-4-7 This release introduces new high perforamnce cache core, which is two orders of magnitude faster.
1.6.0-beta3 2009-1-28 This release breaks JCache into its own ehcache-jcache module and removes all dependencies other than the JDK.
1.6.0-beta2 2008-12-24 The focus of this release is enabling multiple replication schemes in the same configuration.
1.6.0-beta1 2008-10-19 The 1.6 release is a cleanup release which sets the foundation for future development. It updates the required Java version to 1.5, removes consequently redundant libraries and removes long deprecated methods. It also fine tunes some of the newer API behaviours.
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

Release 2.0.0 - 2010-3-4

Type Changes By
fix Changed Store.put() to return boolean instead of void. cache.put() can be more efficient by relying on this return value instead of doing a separate containsKey() check for each cache.put(). Fixes EHC-625. Abhishek Sanoujam
add Added AbstractCacheWriter class for convenience. Fixes EHC-632. Geert Bevin
fix Changed delete and deleteAll CacheWriter methods to take a newly introduced CacheEntry type that contains a key and possibly the element that belongs to it. Geert Bevin
add Added support for cluster topology event listeners. Geert Bevin
add Added support for cluster topology information retrieval to Cache. Geert Bevin
add Added distributed cache events for clustered Terracotta caches through TerracottaCacheEventReplicationFactory and TerracottaCacheEventReplication. Geert Bevin
add Added support for local and remote filtering for the cache event listeners. Geert Bevin
add Implemented rate limiting support for write-behind. Geert Bevin
add Made batch operation type ordering predictable, ie. writes always happen before deletes. Geert Bevin
add Added statistics cache attribute. If set to false, statistics overhead is avoided giving a significant performance improvement in standalone ehcache. By default statistics are on. Chris Dennis
fix Fixed performance regression which occurred in 1.7.0 when sampling statistics was added. For maximum performance statistics can now be turned off in config and during cache construction. Fixes EHC-419. Chris Dennis
fix Changed meaning of maxElementsInMemory=0 for MemoryStore to be unlimited. This puts it in-line with DiskStore and ClusteredStore. This also means that a cache configuration defining no in-memory capacity limit gets a functioning but unlimited capacity cache. This is not expected to cause practical problems because in previous versions, when 0 meant 0, a warning was issued and performance was halved. Fixes EHC-610. Chris Dennis
add Add necessary methods to make the Hibernate RegionFactory implementations forward compatible with the upcoming Hibernate 3.5 release. Fixes EHC-620. Chris Dennis
fix Switch to using millisecond precision for access timestamps in unclustered Ehcache elements. Fixes EHC-622. Chris Dennis
fix Modified DiskStore to be configurable to use multiple RandomAccessFile instances to read the data file. Reduced the scope of synchronization on reading from the DiskStore. Fixes EHC-537. James Abley, Chris Dennis
fix Blocking now allows for concurrent reads on the same key (i.e. same striped lock). Fixes EHC-554. Alex Snaps

Release 2.0.0-beta - 2010-1-29

Type Changes By
add Refactored Cache constructors to allow the use of a fluent interface instead of a series of constructor arguments. Existing constructors remain exactly the same for backward compatibility. Geert Bevin
add Added support for CacheWriters with write-through and write-behind modes. Geert Bevin
add Added support for fast bulk-loading with incoherent mode when clustered with Terracotta. Turning on incoherent mode with cache.setCoherent(false) improves performance for bulk loading. Abhishek Sanoujam
add New attribute for Terracotta clustered-caches, synchronousWrites=true|false -- support for Terracotta's Synchronous Write locking level in cache. Synchronous Write locking level gives greater guarantees, but comes at high cost in terms of scale/latency. Abhishek Sanoujam
add Added XA transaction, using JTA API. Configured through the transactionalMode attribute of a cache in your configuration xml file. Currently only supported on caches clustered using Terracotta's serialized value mode. Alex Snaps
fix Implemented correct cluster wide locking for Terracotta clustered Ehcache Hibernate caches. Fixes EHC-573. Chris Dennis
add Added dynamic configuration support for Terracotta clustered and unclustered Ehcache instances. TTI, TTL, and maximum in-memory and on-disk capacities can be modified at runtime by accessing and mutating the Cache object's CacheConfiguration. Fixes EHC-570. Chris Dennis
add Added Hibernate 3.3+ API cache region factories supporting both singleton and non-singleton cache managers. The new API provides for concurrency improvements that were not possible with the pre-3.3 provider API. Fixes EHC-560. Chris Dennis
add Add support for all tim-distributed-cache configuration options to the terracotta ehcache configuration element. Fixes EHC-584. Chris Dennis
fix Rewrite of MemoryStore to prevent bugs whereby the parallel key data structure became inconsistent with the underlying map, and therefore caused errors during capacity eviction. Fixes EHC-569. Chris Dennis
fix Disabled caches now return null on get rather than returning a potential stale value. This is important now that caches can be disabled at runtime when they may not be empty. Fixes EHC-576. Chris Dennis
add Added "copyOnRead" setting for terracotta clustered caches. At a high level this setting will return distinct value objects upon every get() to a cache. The main driver for this feature is to support caches that are accessed by disparate OSGi bundles Tim Eck

Release 1.7.2 - 2010-1-11

Type Changes By
fix Replaced single threaded use of StringBuffer with StringBuilder. Switched to using valueOf methods for creative primitive wrapper instances instead of new'ing them. Fixes EHC-435. Chris Dennis
fix Added a non-transient cache name field to the Statistics class so that cache names persist after passing through serialization. Fixes EHC-513. Chris Dennis
fix Added the Exception causing the issue to the CacheException. The message now includes the key, rather than null. Fixes EHC-518. Alex Snaps
fix Made "stopped" variable volatile in MulticastKeepaliveHeartbeatSender/Receiver to make it thread-safe Fixes EHC-549. Abhishek Sanoujam
fix Make ExecutorService's use custom ThreadFactory so that pool threads have meaningful names. Fixes EHC-561. Abhishek Sanoujam
fix Use UUID rather than RMI's UID which does not work in GAE. Fixes EHC-434. Greg Luck
add Added CacheManager.clearAllStartingWith(String): void that clears all Caches associated with the cache manager, if the cache name matches the prefix profided Fixes EHC-242. Alex Snaps

Release 1.7.1 - 2009-11-30

Type Changes By
update Enable cache loaders to work with Google App Engine. Greg Luck
fix Fixed Cache.toString() bug introduced in 1.7.0. Fixes EHC-???. Greg Luck
fix Fixed ttl bug introduced in 1.7.0. TTL or TTI values > Integer.MAX_VALUE were incorrectly downcast causing negative values. Most commonly, setting a TTI or TTL of Long.MAX_VALUE caused an exception to be thrown. Fixes EHC-342. Alex Miller
fix Fixed memory visiblity issues with fields in MemoryStore. Made maximumSize and useKeySample final as they never change. Made status and policy volatile as they change but weren't guaranteeing visibility. Fixes EHC-449. Alex Miller
fix Fixed a race that can cause an NPE when evicting with key samples during put. This can happen if there is a concurrent clear() that wipes the map as the keyArray is not updated under the same lock. This happens in tests a lot but is probably less common in actual user code. Fixes EHC-427. Alex Miller
fix Fixed a number of latent visibility bugs in the Cache class. Fixes EHC-443. Chris Dennis
fix Fixed a number of latent visibility bugs in the Element class. Notably updates to the hitCount field are now coherent across multiple threads through the use of an AtomicLongFieldUpdater. Fixes EHC-445. Chris Dennis
fix Fixed bug to avoid any limit on the number of caches that can be configured for replication. Earlier there was a limit on the number of caches that can be configured for replication as the heartbeat size was exceeding the MTU when the number of caches were high and/or the caches had long names. Fixed to break up into multiple payloads in case the heartbeat size exceeds the MTU. Fixes EHC-424. Abhishek Sanoujam
fix Fixed MemoryStore to use sufficient initial capacity for the internal ConcurrentHashMap so that it can accommodate the maximumSize of the store. Fixes EHC-446. Abhishek Sanoujam
fix Allow Terracotta clustered caches to be added programmatically even when the CacheManager was created initially without any Terracotta clustered caches. e.g. Adding a terracotta clustered cache programmatically to the default singleton CacheManager when there is no ehcache.xml present in the classpath. Fixes EHC-415. Abhishek Sanoujam
fix cache.isKeyInCache(null) causes an NPE. Fixed. Fixes EHC-462. Greg Luck
fix Fixed an issue with disk store when an abrupt JVM termination leaves a persistent disk store in a corrupt state. This problem was introduced in 1.6. Fixes EHC-437. Greg Luck
update In Ehcache 1.6 the web package was broken out into the ehcache-web module. However the ShutdownListener is useful even if you are not using web caching - you use it to shutdown a CacheManager in a web app, when the servlet container shuts down. For that reason it should be in core. Putting it back. Fixes EHC-544. Greg Luck
fix Added null check to avoid NPE. Fixes EHC-533. Abhishek Sanoujam
fix Fix for making ehcache work in Google App Engine runtime. JMX classes won't be used when monitoring="off" Fixes EHC-556. Abhishek Sanoujam

Release 1.7.0 - 2009-10-5

Type Changes By
update ehcache now becomes a composite modules which includes ehcache-core, ehcache-terracotta and may include other commonly used modules in the future like ehcache-jcache. Greg Luck
add ehcache-terracotta module, which provides seamless integration to the Terracotta Server for Terracotta based clustering. Terracotta Team
Reduce iterator crossover from 100 to 5 to solve suspected CPU load issue in small caches. Fixes EHC-395. Terracotta Team
Take puts into account for recent use in the eviction algorithms. Fixes an algorithm regression from 1.5. Fixes EHC-396. Greg Luck
Statistics reporting incorrectly in Hibernate in 1.6.2. Fixes EHC-357. Terracotta Team
update Replaced Mutex with higher concurrency strategy (ReadWriteLock based) for both BlockingCache and SelfPopulatingCache Greg Luck

Release 1.6.2 - 2009-8-23

Type Changes By
remove Remove AsynchronousCommandExecutor. This is not used by anyone that I know of and is obsolete as j.u.c. provides a similar mechanism. Greg Luck
fix 1.6.1 cannot read older versions' persistent stores. Thanks to Matt Passell for the patch. Fixes 2840648. Greg Luck
fix Fix retry serialize not working. Thanks to Vitaliy Garnashevich for the patch. Fixes 2831089. Greg Luck
fix Fix statistics counters. Change them to AtomicLong as they now need to be thread-safe to be accurate. Fixes 2831182. Greg Luck
fix Fix to 1.6 where clearOnFlush may now be false and were getting double notification of a remove or expiry if it happened after a flush. Thanks to both Kevin Conaway and Jonathan Barbero. Fixes 2831486. Greg Luck
update Always close open files. Thanks to Vitaliy Garnashevich for the patch. Fixes 2831089. Greg Luck
fix Iterating through ALL_CACHE_MANAGERS sometimes causes ArrayOutOfBoundsException. Bug introduced in 1.6. Fixed. Thanks to Chris Hyzer for reporting. Fixes 2835670. Greg Luck
update Current implementation stops after at least one loader loaded at least one Element. This patch continues to poll other loaders if more keys left to load. Thanks to Vitaliy Garnashevich for the patch. Fixes 2830920. Greg Luck

Release 1.6.1 - 2009-7-27

Type Changes By
fix Fixed ConcurrentModificationException when using DiskStore. This issue would log an exception and those elements waiting to be spooled would be discarded. The DiskStore and cache would continue to run unaffected. 1.6 issue. Greg Luck
fix Fixed regression in 1.6.0. When an Element is not Serializable, but it's key is, then replications via invalidate should still work as only the key needs to be Serializable. 1.6 issue. Greg Luck
update Clarified and made consistent removeQuiet and getQuiet. Both do not update statistics nor call listeners. Greg Luck
update Allow the network interface to be specified on multi-homed machines for MulticastRMICacheManagerPeerProvider. This can now be done by specifying hostName=<hostname or IP of network interface> in the properties. The default interface is used if this is not specified as it has been in past versions. Greg Luck
fix Improved incrementer in MemoryStore to avoid rare overwrites in the key sampling. Thanks to Michael Maraist for this fix. 1.6 issue. Fixes 2823211. Greg Luck
fix Improve performance of memory store eviction. Fixes 2823281. Greg Luck
add Delete directories that were created with auto_created which are meant for one time only use. Greg Luck
fix Fix consistency problem where, with very fast updates to a Cache, gets were returning old versions. Thanks to Marcin Sciesinski for a very clear test case which showed the issue. Fixes 2824181. Greg Luck

Release 1.6.0 - 2009-6-17

Type Changes By
add Added compatibility for Google App Engine. To get started read http://ehcache.sourceforge.net/documentation/googleappengine.html for more details. Greg Luck
update Removed slf4j, which was causing ClassNotFoundException for some users. You can still log via SL4J using the SLF4JBridgeHandler. See {{http://www.slf4j.org/legacy.html}} See the http://ehcache.sourceforge.net/documentation/logging.html for more details. Greg Luck

Release 1.6.0-rc1 - 2009-6-12

Type Changes By
fix Preserve \ and $ when in ehcache.xml. Greg Luck
fix Fix to an issue introduced in 1.6.0-beta5. It was possible for the probabilistic eviction algorithm to return null, which could cause a slow memory leak. Fixed. If this happens on an eviction we do a further selection via iteration which is guaranteed not to return null. Fixes 2791732. Greg Luck
fix Fix Bug in RMIAsynchronousCacheReplicator.clone introduced in the 1.6 beta series. Fixes 2804387. Greg Luck
fix UpdatingSelfPopulatingCache had not been converted to work with non-Serializable objects. Fixed. Fixes 2790350. Greg Luck
fix Fixed rare ConcurrentModificationException when calling cache.flush() to persist to the disk store during cache operation. cache.flush() is now asynchronous as a result. Fixes 2008055. Greg Luck
add added clearOnFlush cache parameter. It determines whether the MemoryStore should be cleared when flush() is called on the cache. By default, the MemoryStore is cleared. Useful is you want to back up a cache to the file system without clearing the MemoryStore. Thanks to Matt Passell for the patch. Greg Luck
update / used to be an illegal character in ehcache cache names. However JBoss 5 uses / in its JPA cache names. / is now a legal character so as to interoperate with JBoss 5. Greg Luck
update Brought back the LruMemoryStore from ehcache-1.5 and prior. This can be switched in for LRU eviction algorithm cache using set java -Dnet.sf.ehcache.use.classic.lru=true By default the new, high performance MemoryStore is used for all eviction algorithms. Greg Luck
update Added slf4j, replacing java.util.logging. I succumbed to the logic that a library should use an abstract logging interface. This _may_ be replaced by configurable logging in ehcache.xml, which will then remove the dependency on sl4j while still permitting its and other logging frameworks use. Greg Luck

Release 1.6.0-beta5 - 2009-5-10

Type Changes By
add Make MemoryStore eviction policies injectable. Greg Luck
fix Fix NPE on cache operations during cache.dispose(); Fixes 2740073. Greg Luck
fix Fix DiskStore recovery after dirty shutdown bug introduced in beta4. Fixes 2750578. Greg Luck
fix Fix MemoryStore concurrency issue introduced in beta4. Greg Luck

Release 1.6.0-beta4 - 2009-4-7

Type Changes By
update Remove many uses of synchronize and replace with new concurrency techniques available in Java 5. A concurrent test with 70 threads doing a realistic mix of operations gets are 92.5 times faster, puts are 30 times faster, removes are 48 times faster, removeAlls are 80 times faster, and keySet is 30 times faster. Greg Luck
add Add replicatePutsViaCopy to the RMI replicator. This determines whether the new elements are copied to other caches (true), or whether a remove message is sent. Defaults to true. A replicateUpdatesViaCopy property was already there. With these two properties, fine-grained control is available to ensure distributed cache coherency is maintained. Fixes 2684466. Greg Luck
update Don't automatically delete the DiskStore index on startup. Fixes 2003322. Greg Luck
fix Fix documentation: missing parentheses from samples.html. Fixes 2540579. Greg Luck
fix The isSerializable() method on Element was too narrowly defined. Adjusted to allow Elements with null values to be Serialized. This change affects DiskStore and replication. Null objects of any class will serialize. Also recorded as 2153609. Fixes 2026586. Greg Luck
fix Made the synchronous RMI replicator log exceptions as SEVERE rather than throwing them, to make this consistent with the asynchronous replicator. The change means that you cannot detect that replication has not occured to a given peer. Given that we are not transactional, this probably does not matter. Fixes 2018964. Greg Luck
fix Notifications happening on removeQuiet when they should not. Fixes 2725134. Greg Luck
fix Extra logging around RMICachePeer. Add the cacheName to the FINE log output. Fixes 2492568. Greg Luck
fix Added support for UTF8 file encoding of ehcache.xml. This makes it possible to specify cache names in non Western languages. Fixes 2584798. Greg Luck
fix Updated provided scope dependency of Hibernate to 3.2.6GA to pick up a signature change in CacheException to Throwable. Fixes 2035287. Greg Luck

Release 1.6.0-beta3 - 2009-1-28

Type Changes By
update Remove all of JSR107 JCACHE into its own module called ehcache-jcache, which will have its own release cycle. The jsr107cache dependency is thus no longer required. Greg Luck

Release 1.6.0-beta2 - 2008-12-24

Type Changes By
update Allow multiple replication schemes to be used within the same CacheManager. i.e. use JMS for some caches and RMI for others. Greg Luck
add Add a reference to Ehcache from CacheStatistics. Request 2128129 Greg Luck
add Add FINE level LOG statement for Hibernate EhCache provider puts. This enables puts to be debugged with LOG statement. Request 2061030. Greg Luck
update Removed cacheManager.getCachePeerProvider() in favour of cacheManager.getCacheManagerPeerProvider("scheme") where scheme is the replication scheme. Each replicator type can then call its own scheme provider, allowing multiple replication schemes to be used within the same CacheManager. Greg Luck

Release 1.6.0-beta1 - 2008-10-19

Type Changes By
remove Removed commons-collections. The LRUHashMap was only being used by early versions of Terracotta integration and is not longer required to support Terracotta. Greg Luck
remove Removed dependency on backport concurrent. java.util.concurrency is now used. Fixes 1987750. Greg Luck
remove Removed dependency on commons-logging. Ehcache now uses java.util.logging at the request of many users. Greg Luck
update 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
update Add the ability for the MBean classes to be used in remote JMX clients, in addition to the current mechanism which uses standard JDK types. The ehcache classpath should be added to the client for this to work. e.g. jconsole -J-Djava.class.path=ehcache.jar Greg Luck
update Due to requests for more sophisticated features and end user experience with the CacheLoader interface the following changes have been made: - A Cache may now have a list of CacheLoaders. If the first loader returns null, the next in the list is attempted until a non-null result occurs or the chain of loaders ends. - If a loader does not load, no element is put in the cache, rather than an element with a null value. This is more consistent with the rest of the API anyway and has been requested by users. - Loaders now have a maxLoadTimeMillis property which sets the maximum amount of time for the loader to wait for the load. - To support sophisticated loaders like the JMSCacheLoader, the CacheLoader interface adds lifecycle methods, so that it can be bound into a cache's lifecyle. Also there is a new factory method for loaders to bring them into line with extensions such that a back-reference to the owning Cache is injected at configuration time. The upshot of these changes is that implementers of CacheLoader will need to update their implementations for these changes. The setter and getter for CacheLoader has been removed because it now a list, not a scalar. New registerCacheLoader and unregisterCacheLoader methods have been added for programmatic configuration. The getCacheLoader method has been removed. Greg Luck
remove Cache configuration individual methods have been deprecated for several years. In this version, the deprecated methods are removed. Use cache.getCacheConfiguration() to get the configuration object and then get individual properties. Greg Luck
remove Cache statistics individual methods have been deprecated for several years. In this version, the deprecated methods are removed. Use cache.getStatistics() to get the Statistics object and then get individual statistics. Greg Luck

Release 1.5.0 - 2008-07-12

Type Changes By
fix 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
fix Updated the BlockingCache.get() JavaDoc to clarify the contract when a RuntimeException is thrown. Fixes 1990091. Greg Luck
fix Added a more meaningful LOG message when a null element is encountered from 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
update 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
fix 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
add 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
update CachingFilter changed to use BufferedOutputStream rather than OutputStream. This is a performance improvement. Thanks to Vitaly Baranovsky for the patch. Fixes 1812267. Greg Luck
update Removed setThreadName usage to increase performance. Fixes 1748591. Greg Luck
add 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
update Clarified JavaDoc and behaviour so that Cache.getQuiet does not update Element statistics but also cache statistics. Fixes 1795131. Greg Luck
update 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
update 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
add 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 RMICacheManagerPeerListenerFactory to enable it to be specified. Fixes 1887683. Greg Luck
add Made ManagementService accessible from IoC containers by providing a constructor. Fixes 1958670. Greg Luck
add 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 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
update 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
fix 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
fix Change CachingFilter to use setHeader rather than addHeader which was duplicating some headers. Fixes 1890915. Greg Luck
fix Updated the JavaDoc to clarify the meaning of the constant SHORT_DELAY. Fixes 1936731. Greg Luck
fix Fixed inefficient shutdown of cache when the cache is not diskPersistent. Fixes 1888993. Greg Luck
fix 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
fix 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
fix ehcache-failsafe.xml was not being included in the maven package. Moved it to resources so that now it is. Fixes 1895147. Greg Luck
fix 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
fix Fixed error in Cache.remove/Ehcache.remove JavaDoc Fixes 1887638. Greg Luck

Release 1.4.0 - 2008-1-31

Type Changes By
fix Update backport-concurrent version to 3.1. This version is available for all versions of Java including 6. Fixes 1819841. Greg Luck
fix Tuned a few unit tests use of Thread.sleep due to the Windows timing service of inaccurate aperture. Some tests that used an added 10ms to allow for Windows now allow for 20ms, based on research published in this bug report. Fixes 1880042. Greg Luck
fix 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
fix NPE in MulticastKeepaliveHeartbeatReceiver when accessing processingThreadPool during startup. Fixes 1819841. Greg Luck
fix RMIAsynchronousCacheReplicator flushReplicationQueue change to speed it up and remove pausing. Thanks to Kyle Sampson for this one. Fixes 1816084. Greg Luck
fix 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
fix CacheStatistics causes a NPE if used for fresh caches. Fixed. Fixes 1828351. Greg Luck
fix Dropped thread renaming in SelfPopulating cache. A debug feature that has probably outlived its usefulness. Fixes 1831446. Greg Luck
fix 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
fix 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
fix Style issue. Abuse of Exceptions. Fixed. Fixes 1831755. Greg Luck
fix JCache.getAll wraps values in Element. Fixed. Fixes 1831823. Greg Luck
fix Replication Thread of Default Cache not disposed. Fixed. Fixes 1802513. Greg Luck

Release 1.4.0-beta - 2007-08-26

Type Changes By
add Add CacheLoaders to ehcache configuration and core classes. Greg Luck
add 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 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
update Add a version number to the ehcache jar manifest as is the Apache convention. Fixes 1737269. Greg Luck
update Include all required libraries in the Sourceforge tarball download. Fixes 1752251. Greg Luck
update 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
fix LfuMemoryStore did not support Non-Serializable objects. Fixes 1744643. Greg Luck
fix 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
fix 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
fix i18n issue in the PageFragmentCachingFilter. Thanks to David Sheldon for the bug report and fix. Fixes 1753349. Greg Luck
fix 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
fix 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. Ehcache 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
fix 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
fix 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
fix 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
fix 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 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
update Enable the DiskStore to be programmtically pluggable in the Store hierarchy. Thanks to Matt Magoffin for the patch. Greg Luck
update 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
fix 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
update 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 Fix issue reported by Fredrik Bertilsson regarding peers entering and leaving a cluster, where the reentered peer would never get updates. Greg Luck
fix Fixed RMICachePeer.getElements so that it does not allow null elements. Fixes 1703340. Greg Luck
fix 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
update Distributed cache - flushing replicationQueue on dispose. We should flush the replication queue rather than clear it on dispose. Fixes 1684223. Greg Luck
fix 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
fix Add note to sample ehcache.xml and documentation about the reserved cache name "default". Fixes 1694609. Greg Luck
update The shutdown hook is now turned off by default. Set the system property net.sf.ehcache.enableShutdownHook=true to turn it on. Greg Luck
fix 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
fix 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
add Added a net.sf.ehcache.jcache package, which is an implementation of JSR107, backed by ehcache. Greg Luck
add Added a net.sf.ehcache.management package, which contains full JMX instrumentation for ehcache. Greg Luck
fix 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
fix 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
fix JBoss, Spring 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
fix Element#equals(Object) causes ClassCastException when the comparison object is not an Element. Fixed. Fixes 1618798. Greg Luck
fix 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 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 Fix issue reported by Fredrik Bertilsson regarding peers entering and leaving a cluster, where the reentered peer would never get updates. Greg Luck
fix Fix bug for the combination of Automatic Peer Discovery and synchronous bootstrapping. Fixes 1661328. Greg Luck
remove 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
update Consolidate shutdown hooks to one on each CacheManager instance. Greg Luck

Release 1.2.4RC - 2006-11-26

Type Changes By
remove 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
add 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
add 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
add 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 Fix typo in lock timeout log message in BlockingCache. Thanks to Matt Magoffin for reporting this bug. Fixes 1574735. Greg Luck
fix 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
fix Fixed NullPointerException on Cache.evictExpiredElements() and added some other NPE guards to Cache. Fixes 1563017. Greg Luck
fix 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
fix ehcache.xsd diskStore path defined as xs:NCName Fixes 1589004. Greg Luck
fix Fix documentation error: Ehcache provider package inconsistent Fixes 1589451. Greg Luck
fix 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
fix CachingFilter and its subclasses now work when upstream filters or servlets return 404 or 302, 301. Greg Luck
fix Fixed rare ConcurrentModificationException in getBoundCachePeers. Thanks to Tony Voss Fixes 1584776. Greg Luck
fix Harden heartbeat sender for IOExceptions and large peer sizes. Thanks to Tony Voss for the patch. Fixes 1583996. Greg Luck
fix 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
fix 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
fix Multiple multicast packets sends multiple heartbeats Fixes 1592324. Tony Voss
fix Infinite recursion in BlockingCache.getKeysNoDuplicateCheck Fixes 1591711. dguist
fix 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
add 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
add 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
add 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
add 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
add Added a new notifyElementEvicted cache event notification as requested by users. Called immediately after an element is evicted from the cache. Evicted in this sense means evicted from one store and not moved to another, so that it exists nowhere in the local cache. In a sense the Element has been removed from the cache, but it is different, thus the separate notification. The usual notifyElementRemoved is not called. Greg Luck
update 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
update 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
update Open up some classes by removing final keyword and changing the constructors to public. Greg Luck
fix 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
fix Fixed a few broken links and inconsistencies in the documentation. Fixes 1529506. Greg Luck
fix Bad dependency scopes in Maven2 POM. Most dependencies are required only at test time. Changed the pom to reflect this. Fixes 1542696. Greg Luck
fix 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
fix Fixed a bug where in BlockingCache and SelfPopulatingCache where setTimeoutMillis was set to a non zero value. Fixes 1550043. Greg Luck
fix 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
add Added a ShutdownListener which implements ServletContextListener for shutting down all CacheManagers in a web application. Fixes 1521843. Daniel Wiell
fix 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
fix Reduce the memory used by flushSpool() in DiskStore. See http://gregluck.com/blog/archives/2006/07/tuning_memory_u.html for details. Greg Luck
fix 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
fix 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
fix 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
add 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
add 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
fix This was reported by Victor Volle and is a duplicate of 1492900. Fixed. Fixes 1190614. Greg Luck
fix 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
fix 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
fix 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
update Change spooling mechanism to use less memory, so as to avoid memory spikes. Greg Luck

Release 1.2.1RC - 2006-6-4

Type Changes By
add 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
add 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
add 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
add 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
add 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
add Andy McNutt's JNDI-based manual RMI replication added. See ehcache.xml example for how to use. Greg Luck
add 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
add 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 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
add 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
fix 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
fix 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
fix 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
fix 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
fix Changing the API to Object from Serializable 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
fix 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
fix 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
update License updated to Apache 2.0. Greg Luck
update 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
update 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
remove 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
add Feature Request 1081071. Added the ability to specify subdirectories under System Property paths. e.g. java.io.tmpdir/one Greg Luck
add 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
fix 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
fix 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
add 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
add 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
add 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
add 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 the cache is diskPersistent, it can be programmatically flushed, in addition to the automatic flush which happens at shutdown. Greg Luck
add 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
add DiskStore is now up to 12 times faster in certain operations and much more scalable. Greg Luck
add 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
update Clover test coverage raised to 86%. Greg Luck
update Feature Request 431481 Distributed: The ability to notify cache event listeners excluding CacheReplicators Greg Luck
update Feature Request 1431393 Events from remote in distributed cache should be received by any non CacheReplicator listeners Greg Luck
update Patch 1158788. Fix for dependencies list... MemoryStore.java to remove Apache commons-collections for JDK1.4 users Greg Luck
fix change default configuration to use context classloader Fixes 1122734. Greg Luck
fix Fix for DiskStore to deserialize using Thread.currentThread().getContextClassLoader() Fixes 1324221. Greg Luck
fix CacheManager.shutdown now uses a Class rather than an instance lock. Fixes 1261613. Greg Luck
fix Configurator gets a file not found when files contain spaces. Fixes 1237017. Greg Luck
fix DiskStore degrades under load. Fixes 1332728. Greg Luck
fix Change classloader to Thread.currentThread().getContextClassLoader() for ehache.xml. Fixes 1079529. Greg Luck
fix DiskStore data file is not deleted when index is corrupt. Fixes 1414674. Greg Luck
fix JavaDoc documentation fix for element.getLastAccessTime returns 0 for element just created Fixes 1224325. Greg Luck
fix Documentation should advise using the Hibernate supplied plugin rather than the older one in ehcache which is now deprecated. Fixes 1247019. Greg Luck
fix 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. Greg Luck
fix Fix bug introduced in 1.2 beta series. Changed ant script to avoid compiling with clover in dists Greg Luck
fix Fix bug introduced in 1.2 beta series. Cannot load configuration from jar (or any non-file URL). Fixes 1410374. Greg Luck
fix 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 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 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 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
remove Split out the entire constructs package. These are now in a new subproject: ehcache-constructs, which has been released. See http://ehcache.org/ehcache-constructs for more details. Greg Luck
remove removed the dependency on Doug Lea's concurrency library. Greg Luck
add Add new documentation on cache configuration and hibernate performance tuning. Greg Luck
fix 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
add Added SelfPopulatingCacheManager Greg Luck
add Added a new diskExpiryThreadIntervalSeconds configuration option to ehcache.xml, to allow tuning of the expiry thread per cache. Greg Luck
add 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
fix Expiry Thread now has a default time of 2 minutes, not 25. Greg Luck
fix Expiry Thread now dies immediately on DiskStore disposal. Greg Luck
fix cache.calculateInMemorySize() now returns a non-zero value Greg Luck
fix Bug 1025130 - Null Pointer Exception when no default cache configured. Now we throw a CacheException with a meaningful message. Greg Luck
fix Bug 1025128 IBM Websphere alway requires commons-collection.jar, even though it is never used. Updated requirements to note this. Greg Luck
fix Patch 1030960. JDK1.4 and higher now chain exception thrown from SelfPopulatingCache. Greg Luck
fix 1033061 Fix to Thread naming in SelfPopulatingCache so that the old name is always put back. Greg Luck
fix 1003659 build script unfriendly to IDE: IDE builds should now work. Greg Luck

Release 0.9 - 2004-7-5

Type Changes By
add 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
add Added getQuiet and putQuiet methods to Cache. These methods are the same as get and put but do not affect statistics. Greg Luck
add Implemented an Element clone method. Greg Luck
add Added calculateInMemorySize() method to Cache to measure the approximate size of a cache's memory footprint. Greg Luck
update Increased Clover test coverage to above 80%. Greg Luck
update Added many new tests for idle expiry. Greg Luck
update 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
update Test new xml format scenarios for eternal, time to idle and time to live Greg Luck
update Started adding performance tests to ensure there are no regressions over time. Greg Luck
add 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 <br/><br/> 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. <br/> <br/> SelfPopulatingCollectionsCache - a SelfPopulatingCache that adds threading safety where it is known in advance that all entries will be collections. <br/> <br/> The package is useful for, inter alia, : <br/><br/> - Web Page caches <br/> - Search Engine caches<br/> <br/><br/> See the tests for examples of how to use this package. <br/><br/> 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
fix JavaDoc fixups Greg Luck
fix 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 Greg Luck
fix Fixed bugs with getSize and getKeys, which were not checking for duplicate keys between the memory and disk stores. Greg Luck

Release 0.8 - 2004-5-15

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

Release 0.7 - 2004-1-2

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

Release 0.6 - 2003-12-8

Type Changes By
remove 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
fix Hibernate Cache Provider. Fixed bug where incompatible timestamps were generated Greg Luck
fix Time to Idle" documentation bug. Greg Luck
fix Fixed documentation bug in ehcache.xml and ehcache-failsafe.xml where "Time to Live" was incorrectly referred to as "Time to Idle" Greg Luck

Release 0.5 - 2003-11-18

Type Changes By
add Changed from JDK1.4 Logging to Commons Logging. This is to permit JDK1.2 and JDK1.3 to use EHCache. Greg Luck
add Added Apache Commons Collections 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
add Added LICENSE.txt to the jar in the distribution Greg Luck
fix Don't create a Disk Store when overflowToDisk="false" is set in ehcache.xml Greg Luck
fix toString() methods now report on all fields Greg Luck
fix Fixed documentation bug in ehcache.xml and ehcache-failsafe.xml where "Time to Live" was incorrectly referred to as "Time to Idle" Greg Luck

Release 0.4 - 2003-11-13

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