Welcome to the Oracle Coherence Spring Project

The Coherence Spring project provides bootstrapping support of Oracle Coherence for Spring Framework and Spring Boot. Coherence Spring also provides a set of components to aid in the integration of Oracle Coherence and various other projects of the Spring ecosystem:

• Spring Data

• Spring’s Cache Abstraction

• Spring Session

Furthermore, the project also provides various examples to show-case the integration of Oracle Coherence into Spring-based projects.

Documentation

Detailed project documentation is available on the Coherence Spring website. This includes the reference documentation in various formats (Multi-page/Single-page HTML, PDF), as well as extensive JavaDoc for the Coherence Spring source code.

4.2.0	Website	Multi-page HTML	Single-page HTML	PDF	API Doc.
4.2.1-SNAPSHOT	Website	Multi-page HTML	Single-page HTML	PDF	API Doc.
3.4.0	Website	Multi-page HTML	Single-page HTML	PDF	API Doc.
3.4.1-SNAPSHOT	Website	Multi-page HTML	Single-page HTML	PDF	API Doc.

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

Supported Versions

Coherence Spring	Java	Coherence CE	Spring	Boot	Jakarta	Git Branch/Tag
4.x	17, 21	24.03.1	6.x	3.3.x	✔	main
3.x	11, 17, 21	22.06	5.x	2.x		3.x

Quick Start

In order to get started quickly, please read the reference guide as it provides a detailed Quickstart chapter (v4.2.0).

Through the reference documentation we 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 Spring, you need to have installed:

• Java 17 (Java 21 is fine)

• Git

Check out sources

Check out the project using Git:

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

Coherence Spring 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 Documentation

./mvnw clean package -pl coherence-spring-docs

Build the project website

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

Deploy the project website

./mvnw deploy -pl coherence-spring-site

Getting Support

In case you have questions or if you run into issue using the Coherence Spring 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 Spring is Open Source software released under The Universal Permissive License (UPL), Version 1.0.