Recipe to migrate the use of Ehcache 2.0 to 3.0 in Hibernate

[tkvangorder]

Hibernate has deprecated the use of the ehcache 2.0 in favor of using jcache (with the ehcache 3.0 as the underlying implementation)

This recipe should:

• Replace hibernate-ehcache dependency with hibernate-jcache
• It should replace the hibernate.cache.region.factory_class property with jcache
• It should add the following two properties :

<property name="hibernate.javax.cache.provider" value="org.ehcache.jsr107.EhcacheCachingProvider"/>
<property name="hibernate.javax.cache.uri" value="file:/META-INF/ehcache.xml"/>

And finally if the ehcache.xml file does not exist, it should create that file with a defaultCache entry:

<ehcache>
    <defaultCache maxEntriesLocalHeap="1000" eternal="false" timeToIdleSeconds="300" timeToLiveSeconds="600">
    </defaultCache>
</ehcache>

[knutwannheden]

This is for Hibernate 6.0, right?

[tkvangorder]

Yes, this is for the move to Hibernate 6.0. I believe this approach could be applied to versions of Hibernate 5.4 and higher. I honestly have not worked with Hibernate in a very long time, but I ran across this as part of the work in openrewrite/rewrite-migrate-java#157 (The hibernate-ehcache no longer exists in Hibernate 6.)

[bsmahi]

@tkvangorder @knutwannheden @timtebeek In my view, Yes, hibernate-ehcache has been replaced with hibernate-jcache in Hibernate 6, this what have implemented in my recent project.

<dependency>
	<groupId>org.hibernate</groupId>
	<artifactId>hibernate-jcache</artifactId>
	<version>6.1.6.Final</version>
</dependency>

Hence the above dependency can be added for while migrating to Hibernate 6 and we have add the following entry in application.properties file

spring.jpa.properties.hibernate.cache.region.factory_class=org.hibernate.cache.jcache.internal.JCacheRegionFactory

So we can a recipe around it. Happy to work if the above solution is viable

Thanks,
Mahendra/Mahi

[timtebeek]

Apologies for the late reply here; yes that seems like the correct step to take here, thanks!