Welcome to the Oracle Coherence Spring Project
The Coherence Spring project provides boostrapping 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 eco-system:
-
Spring’s Cache Abstraction
-
Spring Cloud Config Server (In-process)
-
Spring Session (TBD)
-
Spring Data (TBD)
Documentation
Detailed project documentation for the latest snapshot release (3.0.0-SNAPSHOT) is available in the Reference Guide which is provided in various formats:
Extensive JavaDoc for the Cohrence Spring code is also available in the Coherence Spring API Documentation.
Note
|
The Apache Maven-based snapshots and releases for this project are published to Maven Central. |
Quick Start
In order to get started quickly, please read the reference guide as it provides a detailed Quickstart chapter.
Through the reference documentation we will also refer to various demo and sample aplications. Those are part of this repository and you can find those in the coherence-spring-samples module.
Building from Source
Requirements
In order to build Coherence Spring, you need to have installed:
Note
|
When using Coherence Spring merely as a dependency in a project, without intending to build the project from source code, then an installed JDK 8 version is sufficient. |
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 Documentation
./mvnw clean package -pl coherence-spring-docs -Pspring
Build the project website
./mvnw clean install -pl coherence-spring-site -Pspring
Deploy the project website
./mvnw com.github.github:site-maven-plugin:site -pl coherence-spring-site -Pspring
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
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.