README Notes for Enterprise Ehcache

    See http://ehcache.org to get started. 
    
    See http://ehcache.org for a full change log, usage, product versions
    and comprehensive documentation.

	See http://www.terracotta.org/kit/reflector?kitID=default&pageID=BigMemoryEhcache for detailed documentation on configuring BigMemory

    Introduction
    ============
    
    Ehcache is a pure Java, in-process cache providing a wealth of features,
    including the following:
    
    * Scalability
      Provides memory and disk stores (to Gigabytes and hundreds of caches) and
      is tunable for high-concurrent load on large multi-CPU servers.
      
    * Flexibility
      Supports object or serializable caching, cache-wide or element-based
      expiry policies, LRU/LFU/FIFO cache eviction policies, runtime
      configuration of caches, and works with Hibernate and Google App Engine.
      
    * Persistence
      Application persistence by disk store means that data survives JVM
      restarts and can be flushed to disk on demand.

    * Distribution
      Use Terracotta clustering or a replication mechanism (RMI or JGroups)
      to distribute the cache over multiple nodes.
      
    * Off-Heap Memory Store (Enterprise Ehcache only)
      Boosts cache performance by expanding off-heap storage and taking
      advantage of memory speed without the downside of Java GC pauses.

    Ehcache is available both as an open-source project and in commercial editions (Enterprise Ehcache).

    Java Requirements
    =================

    Ehcache 1.7.2 and above supports Java 1.5 and 1.6 at runtime. Ehcache final
    releases are compiled with -target 1.5.

    The Ehcache 1.5 branch is being maintained for Java 1.4 users.

    Dependencies
    ============

    SLF4J API and one concrete logging implementation. The API jar and the JDK14
    logging jar are included in the distribution.

    Installation
    ============
    Place the ehcache-core-ee.jar, slf4j-api.jar and slf4j-jdk14.jar (or the
    concrete SLF4J logging implementation library of your choice) on your
    classpath.

    Create an ehcache.xml configuration from the one supplied in the
    distribution and place it along with your license key file in the root of
    your classpath.
    
    For a quick-start guide to using this Ehcache edition, see this 
    Ehcache quick-start guide.

    Maven POM snippet
    =================

    Ehcache Enterprise maven artifacts can be found at Terracotta Maven repostiory only.
	You will need to include that repository in your pom:
	
      <repositories>    
        <repository>
          <id>terracotta-releases</id>
          <url>http://www.terracotta.org/download/reflector/releases</url>
        </repository>
      </repositories>
	  
	
    The Maven snippet for ehcache-core-ee (commercial edition) is:

        <dependency>
          <groupId>net.sf.ehcache</groupId>
          <artifactId>ehcache-core-ee</artifactId>
          <version>[current-version]</version>
        </dependency>

		 
    Documentation
    =============
    See http://ehcache.org/documentation for full documentation.

    The JavaDoc is in the distribution and also online at http://ehcache.org/apidocs

    Licenses
    ========
    The license is in the licenses folder.

    Ehcache 1.7.1 and higher uses SLF4J for logging. The SLF4J license is
    included in the licenses folder.

    Known Issues
    ============

    1. There are a number of known issues and workarounds for Tomcat. See the 
    Using Ehcache with Tomcat chapter in the online documentation.

    2. See the FAQ online for a current list.