Home

Ehcache 3 developer wiki

Developer, be welcome!

This wiki contains all design documents and other related material to doing development on Ehcache, not using Ehcache! If you are a developer that wants to get involved in developing new features, fixing bugs, extend the existing or implement a new module based on the Ehcache3 SPIs, this is the place you’ve been looking for. Be welcome!

How to contribute?

Process

Code layout

The code core of Ehcache is split in three core modules:

1. the API module, which …​ ;

2. the Core module, that …​ ; and

3. the Implementation module, containing …​ .

Contributor agreement

How to extend?

SPIs

org.ehcache.spi.service, org.ehcache.spi.cache

Extension points

Fundamental concepts

Modular approach

org.ehcache.spi.ServiceProvider, org.ehcache.spi.service.Service

Configuration

org.ehcache.config.CacheConfiguration, org.ehcache.spi.service.ServiceConfiguration, org.ehcache.config.xml.XmlConfigurationParser

Note	For more information on how the configuration is parsed, resolved and services are then bootstrapped, please read the Bootstrapping design doc.