EhCacheManagerFactoryBean should share per cacheManagerName and only call shutdown if it originally created its CacheManager [SPR-11178]

[spring-projects-issues]

Raul Kripalani opened SPR-11178 and commented

The shared=true option instructs the EhCacheManagerFactoryBean that the CacheManager is shared across several contexts.

Unfortunately, the destroy() method is oblivious to this fact and shuts down the CacheManager unconditionally.

EhCacheManagerFactoryBean should keep track of the contexts that are using the CacheManager through a static counter, and only shut down the CacheManager if no more contexts are using it.

---

Affects: 3.2.5

Referenced from: commits a9605a1

[spring-projects-issues]

Juergen Hoeller commented

The original intent of the 'shared' feature on EhCacheManagerFactoryBean was to share the Spring-managed CacheManager with non-Spring code in the same application. In such a scenario, the lifecycle is still up to EhCacheManagerFactoryBean, so it also performs the shutdown there.

In fact, the original singleton CacheManager feature in EhCache was never a pretty feature. It's a static singleton with no control over whether it is actually compatible with somebody else's CacheManager requirements. This is what EhCacheManagerFactoryBean supports up until Spring 3.2.

Now, as of EhCache 2.5, CacheManagers are also being shared per name, which we haven't been supporting yet. We do support setting a 'cacheManagerName'; however, we do not allow for sharing based on that name yet: If you set 'shared' and a 'cacheManagerName', it's still unconditionally shared as a singleton, with no differentiation by name.

I'm about to commit dedicated support for this EhCache 2.5+ style of sharing per name. We'll only fall back to old-school singleton sharing for EhCache 2.1-2.4 (note that Spring 4.0 requires EhCache 2.1+ now).

Juergen

[spring-projects-issues]

Juergen Hoeller commented

I eventually went with a new "acceptExisting" flag allows for sharing per "cacheManagerName" on EhCache 2.5+, including controlled shutdown by the EhCacheManagerFactoryBean that actually created the CacheManager instance.

The "shared" mode still exists as-is, for compatibility with non-Spring code that uses EhCache's old access style. Simply choose "acceptExisting" over "shared" now for sharing by cache manager name and for controlled shutdown.

Juergen

[spring-projects-issues]

Raul Kripalani commented

Hi Juergen,

Many thanks for the prompt improvement.

Any chance to backport the new attribute to 3.2.x?

Thanks,
Raúl.

[spring-projects-issues]

Juergen Hoeller commented

EhCache 2.5+ focus was a Spring 4.0 theme anyway, so it really fits there, and this kind of change is easy enough to implement in Spring 4.0's EhCache 2.1+ world. There are no plans for a backport to 3.2.x, I'm afraid, primarily because the 3.2.x version of EhCacheManagerFactoryBean is convoluted enough already, bridging between EhCache 1.x/2.0/2.1.

That said, an upgrade to Spring Framework 4.0 GA - to be released tomorrow - might not be as hard as it sounds. For most applications, we expect it to be a drop-in upgrade that's not much more than a change of version numbers in your POM. You could simply give it a try and see how it goes, even against current 4.0.0.BUILD-SNAPSHOT right now...

Juergen