Welcome to the Oracle Coherence Hibernate Project

The Oracle Coherence Hibernate project implements integration points between Oracle Coherence/Coherence CE and the Hibernate Object/Relational Mapping (ORM) framework.

Two primary integration points are covered currently:

• using Coherence as a second-level cache (2LC) in Hibernate

• using Hibernate as a Coherence CacheStore implementation

Starting with Coherence Hibernate 3.x, we support Jakarta EE. Coherence Hibernate 2.x will continue to support Java EE.

Coherence Hibernate	Java	Coherence CE	Hibernate	Jakarta	Git Branch/Tag
3.0.x	17	24.09	5.6, 6.x	✔	main
2.3.x	11	22.06	4.3 - 5.6		2.3.x

Coherence Hibernate 3.0.3

Due to Hibernate Cache API changes, Coherence Hibernate 3.0.3 provides dedicated Maven modules targeting those Hibernate versions:

• coherence-hibernate-cache-53 supports Hibernate 5.6.x

• coherence-hibernate-cache-6 supports Hibernate 6.x

Coherence Hibernate 2.3.5

Due to Hibernate Cache API changes, Coherence Hibernate 2.3.5 provides dedicated Maven modules targeting those Hibernate versions:

• coherence-hibernate-cache-4 supports Hibernate 4.3.x

• coherence-hibernate-cache-5 supports Hibernate 5.0.x and 5.1.x

• coherence-hibernate-cache-52 supports Hibernate 5.2.x

• coherence-hibernate-cache-53 supports Hibernate 5.3.x, 5.4.x,5.5.x and 5.6.x

Documentation

Detailed project documentation is available on the Coherence Hibernate website. This includes the reference documentation as well as extensive JavaDoc for the Coherence Hibernate source code.

3.0.3	Website	API Doc.
3.0.4-SNAPSHOT	Website	API Doc.
2.3.5	Website	API Doc.
2.3.6-SNAPSHOT	Website	API Doc.

Note	The Apache Maven-based snapshots and releases for this project are published to Maven Central.

Supported Java & Coherence Versions

Coherence Hibernate	Java	Coherence CE	Jakarta EE	Git Branch/Tag
3.0.3	17	24.09	✅	v3.0.3
3.0.4-SNAPSHOT	17	24.09	✅	main
2.3.5	11	22.06.7		v2.3.5
2.3.6-SNAPSHOT	11	22.06.7		2.3.x

Supported Hibernate Versions

Hibernate	Coherence Hibernate 2.3.x	Coherence Hibernate 3.0.x
4.3.x	✅
5.0	✅
5.1	✅
5.2	✅
5.3	✅
5.4	✅
5.5	✅
5.6	✅	✅
6.0		✅
6.1		✅
6.2		✅
6.4		✅
6.6		✅

Samples

The reference documentation will also refer to various demo and sample applications. Those are part of this repository, and you can find those in the samples module.

Building from Source

Requirements

In order to build Coherence Hibernate (main branch), you need to have installed:

• JDK 17

• Git

Check out sources

Check out the project using Git:

git clone https://github.com/coherence-community/coherence-hibernate.git
cd coherence-hibernate

Coherence Hibernate uses Apache Maven as build tool. You do not need to have Maven installed to build the project. Simply use the provided Maven Wrapper, e.g.:

• Windows: mvnw.cmd clean package

• Linux/Mac: ./mvnw clean package

Build the entire project

Build the entire project using Maven:

./mvnw clean package

Offline Builds

In case you are offline, and you run into issues building the project, e.g. the Coherence cluster as part of JUnit tests does not start up successfully, then you may have to provide additional command line arguments:

./mvnw clean package -DargLine="-Dcoherence.localhost=127.0.0.1 -Djava.net.preferIPv4Stack=true"

Build the project website

./mvnw clean install -pl coherence-hibernate-site

Deploy the project website

./mvnw deploy -pl coherence-hibernate-site

Getting Support

In case you have questions or if you run into issue using the Coherence Hibernate project, please feel free to reach out to us either via:

• Stackoverflow using the oracle-coherence tag

• Slack

Both support channels are monitored by the project community.

Contributing

We would love to review your Pull requests. Please see the contributor guidelines for details.

License

Coherence Hibernate is Open Source software released under The Universal Permissive License (UPL), Version 1.0.