| 1 |
<html><head> |
| 2 |
<meta http-equiv="content-type" content="text/html; charset=ISO-8859-1"> |
| 3 |
</head><body> |
| 4 |
<pre> README Notes |
| 5 |
|
| 6 |
The project home page is http://ehcache.org. Please see http://ehcache.org for a full change log, usage, product versions |
| 7 |
and comprehensive documentation. |
| 8 |
|
| 9 |
|
| 10 |
Introduction |
| 11 |
============ |
| 12 |
Ehcache is a pure Java, in-process cache with the following features: |
| 13 |
|
| 14 |
1. Fast and Light Weight |
| 15 |
1.1 Fast |
| 16 |
1.2 Simple |
| 17 |
1.3 Small foot print |
| 18 |
1.4 Minimal dependencies |
| 19 |
2. Scalable |
| 20 |
2.1 Provides Memory and Disk stores for scalabilty into gigabytes |
| 21 |
2.4 Scalable to hundreds of caches |
| 22 |
2.3 Tuned for high concurrent load on large multi-cpu servers |
| 23 |
2.4 Multiple CacheManagers per virtual machine |
| 24 |
3. Flexible |
| 25 |
3.1 Supports Object or Serializable caching |
| 26 |
3.2 Support cache-wide or Element-based expiry policies |
| 27 |
3.3 Provides LRU, LFU and FIFO cache eviction policies |
| 28 |
3.4 Provides Memory and Disk stores |
| 29 |
3.5 Distributed |
| 30 |
3.6 Dynamic, Runtime Configuration of Caches |
| 31 |
4. Standards Based |
| 32 |
4.1 Full implementation of JSR107 JCACHE API |
| 33 |
5. Extensible |
| 34 |
5.1 Listeners may be plugged in |
| 35 |
5.2 Peer Discovery, Replicators and Listeners may be plugged in |
| 36 |
5.3 Cache Extensions may be plugged in |
| 37 |
5.4 Cache Loaders may be plugged in |
| 38 |
5.5 Cache Exception Handlers may be plugged in |
| 39 |
6. Application Persistence |
| 40 |
6.1 Persistent disk store which stores data between VM restarts |
| 41 |
6.2 Flush to disk on demand |
| 42 |
7. Listeners |
| 43 |
7.1 CacheManager listeners |
| 44 |
7.2 Cache event listeners |
| 45 |
8. JMX Enabled |
| 46 |
9. Distributed Caching |
| 47 |
10. Support for replication via RMI or JGroups |
| 48 |
10.1 Peer Discovery |
| 49 |
10.2 Reliable Delivery |
| 50 |
10.3 Synchronous Or Asynchronous Replication |
| 51 |
10.4 Copy Or Invalidate Replication |
| 52 |
10.5 Transparent Replication |
| 53 |
10.6 Extensible |
| 54 |
10.7 Bootstrapping from Peers |
| 55 |
11. Cache Server |
| 56 |
11.1 RESTful cache server |
| 57 |
11.2 SOAP cache server |
| 58 |
11.3 comes as a WAR or as a complete server |
| 59 |
12. Java EE and Applied Caching |
| 60 |
12.1 Blocking Cache to avoid duplicate processing for concurrent operations |
| 61 |
12.2 SelfPopulating Cache for pull through caching of expensive operations |
| 62 |
12.3 Java EE Gzipping Servlet Filter |
| 63 |
12.4 Cacheable Commands |
| 64 |
12.5 Works with Hibernate |
| 65 |
12.6 Works with Google App Engine |
| 66 |
12.7 Transactional support through JTA |
| 67 |
13. High Quality |
| 68 |
13.1 High Test Coverage |
| 69 |
13.2 Automated Load, Limit and Performance System Tests |
| 70 |
13.3 Specific Concurrency Testing |
| 71 |
13.4 Production tested |
| 72 |
13.5 Fully documented |
| 73 |
13.6 Trusted by Popular Frameworks |
| 74 |
13.7 Conservative Commit policy |
| 75 |
13.8 Full public information on the history of every bug |
| 76 |
13.9 Responsiveness to serious bugs |
| 77 |
14. Open Source Licensing |
| 78 |
14.1 Apache 2.0 license |
| 79 |
|
| 80 |
Java Requirements |
| 81 |
================= |
| 82 |
|
| 83 |
Ehcache 1.7.2 and above supports Java 1.5 and 1.6 at runtime. Ehcache final releases are compiled with -target 1.5. |
| 84 |
|
| 85 |
The Ehcache 1.5 branch is being maintained for Java 1.4 users. |
| 86 |
|
| 87 |
Dependencies |
| 88 |
============ |
| 89 |
|
| 90 |
SLF4J API and one concrete logging implementation. The API jar and the JDK14 logging jar are included in the distribution. |
| 91 |
|
| 92 |
Maven Based Development |
| 93 |
======================= |
| 94 |
|
| 95 |
Most Ehcache modules are placed in the central Maven repository. |
| 96 |
|
| 97 |
The Maven snippet for ehcache is: |
| 98 |
|
| 99 |
<dependency> |
| 100 |
<groupid>net.sf.ehcache</groupid> |
| 101 |
<artifactid>ehcache</artifactid> |
| 102 |
<version>[current-version]</version> |
| 103 |
<type>pom</type> |
| 104 |
</dependency> |
| 105 |
|
| 106 |
To deploy to a Terracotta server you also need to add the following: |
| 107 |
|
| 108 |
|
| 109 |
<dependency> |
| 110 |
<groupId>org.terracotta</groupId> |
| 111 |
<artifactId>terracotta-toolkit-1.2-runtime</artifactId> |
| 112 |
<version>3.1.0</version> |
| 113 |
</dependency> |
| 114 |
|
| 115 |
|
| 116 |
<repositories> |
| 117 |
<repository> |
| 118 |
<id>terracotta-repository</id> |
| 119 |
<url>http://www.terracotta.org/download/reflector/releases</url> |
| 120 |
<releases> |
| 121 |
<enabled>true</enabled> |
| 122 |
</releases> |
| 123 |
</repository> |
| 124 |
</repositories> |
| 125 |
|
| 126 |
Then create an ehcache.xml configuration from the one supplied in the distribution and place it in the root of your classpath. |
| 127 |
|
| 128 |
|
| 129 |
Non-Maven Based Development |
| 130 |
=========================== |
| 131 |
Place the ehcache-core.jar, slf4j-api.jar and slf4j-jdk14.jar, or the concrete SLF4J logging implementation library of your choice into your classpath. |
| 132 |
|
| 133 |
For use with Terracotta, copy the ehcache-terracotta.jar to your classpath. |
| 134 |
|
| 135 |
Then create an ehcache.xml configuration from the one supplied in the distribution and place it in the root of your classpath. |
| 136 |
|
| 137 |
Running the Terracotta Server at Development Time/Integration Testing |
| 138 |
===================================================================== |
| 139 |
|
| 140 |
The Terracotta server is in the terracotta directory. It includes start and stop scripts. |
| 141 |
|
| 142 |
For Maven based development, there is a tc-maven-plugin which works much like the Jetty plugin. See USING-WITH-MAVEN.txt, |
| 143 |
which shows how to add the server to your integration test phase and interactive command use. |
| 144 |
|
| 145 |
For Ant based development, the tc-maven-plugin can be called from Ant. See USING-WITH-ANT.txt, |
| 146 |
which shows how to add the server to your Ant build, and how to use the server interactively from Ant. |
| 147 |
|
| 148 |
Samples |
| 149 |
======= |
| 150 |
See the samples directory for ready-to-run samples which show to use the full features of Ehcache, including use with Terracotta. |
| 151 |
|
| 152 |
Documentation |
| 153 |
============= |
| 154 |
See http://ehcache.org/documentation for full documentation. |
| 155 |
|
| 156 |
The JavaDoc is in the distribution and also online at <a href="http://ehcache.org/apidocs">http://ehcache.org/apidocs</a> |
| 157 |
|
| 158 |
Licenses |
| 159 |
======== |
| 160 |
This kit contains ehcache code which is governed by the Apache License, version 2.0. The license is in the licenses folder. |
| 161 |
It also contains the Terracotta server which is governed by the Terracotta Public License, version 1.0. |
| 162 |
|
| 163 |
Ehcache 1.7.1 and higher uses SLF4J for logging. The SLF4J license is included in the licenses folder. |
| 164 |
|
| 165 |
Known Issues |
| 166 |
============ |
| 167 |
|
| 168 |
1. There are a number of known issues and workarounds for Tomcat. See the Using Ehcache with Tomcat chapter |
| 169 |
in the online documentation. |
| 170 |
|
| 171 |
2. See the FAQ online for a current list. |
| 172 |
|
| 173 |
</pre> |
| 174 |
</body></html> |
| 175 |
|
| 176 |
|