Ehcache 2.5 Documentation

The following sections describe some of the topics covered in Ehcache 2.5 documentation.

If you are new to caching, start with the following pages:

• Introduction to caching
• Concepts in caching
• Code samples

• Automatic Resource Control (ARC): Dynamic sizing of memory and other resources, and pinning caches and entries. ARC provides a wealth of benefits, including:

  • Sizing limitations on in-memory caches to avoid OutOfMemory errors
  • Pooled (CacheManager-level) sizing – no requirement to size caches individually
  • Differentiated tier-based sizing for flexibility
  • Sizing by bytes, entries, or percentages for more flexibility
  • Keeping hot or eternal data where it can substantially boost performance

• Compatibility Matrix

A Distributed or Replicated Cache?

If your application node share cached data, and you evaluating distribution versus replication, see this page on cache topologies.

Integrating Ehcache

NOTE: Some containers and frameworks have a built-in dependency on earlier versions of Ehcache and may have out-of-date Ehcache in their classpath. In this case, an older version of Ehcache may actually be loaded at runtime, which can cause ClassNotFound and other errors.

• Hibernate
• Coldfusion
• Containers (Tomcat, Glassfish)
• Grails
• Ruby (Rails and JRuby)
• Transactional Environments (JTA)
• Google App Engine

Improving Performance and Troubleshooting

• GC Tuning
• Logging
• RMI Debugger

Previous Versions

Documentation is available for the following versions of Ehcache:

• Ehcache 2.4.x
• Ehcache 2.0-2.3
• Ehcache 1.7.1
• Ehcache 1.6
• Ehcache 1.5
• Ehcache 1.4
• Ehcache 1.3.0
• Ehcache 1.2.4
• Ehcache 1.2.3
• Ehcache 1.1