98 lines
7.2 KiB
Plaintext
98 lines
7.2 KiB
Plaintext
|
|
= Spring Session MongoDB
|
|
|
|
Spring Session MongoDB provides a solution for Spring Session in a MongoDB data store.
|
|
|
|
* Accessing a session from any environment (i.e. web, messaging infrastructure, etc)
|
|
* In a web environment
|
|
** Support for clustering in a vendor neutral way
|
|
** Pluggable strategy for determining the session id
|
|
** Easily keep the HttpSession alive when a WebSocket is active
|
|
|
|
== Project Status
|
|
|
|
We go to great lengths to ensure smooth upgrades. We also seek to make your upgrade on major versions of Java can be as smooth
|
|
as possible.
|
|
|
|
Check the matrix below to see the status of supported versions:
|
|
|
|
.Spring Session for MongoDB Status
|
|
[cols=4]
|
|
|===
|
|
| Job | `master` branch (`2.2`) | `2.1.x` | `2.0.x`
|
|
|
|
| Test - JDK 8
|
|
| image:https://ci.spring.io/api/v1/teams/spring-team/pipelines/spring-session-data-mongodb/jobs/spring-session-data-mongodb-test-jdk8/badge[link="https://ci.spring.io/teams/spring-team/pipelines/spring-session-data-mongodb"]
|
|
| image:https://ci.spring.io/api/v1/teams/spring-team/pipelines/spring-session-data-mongodb-2.1.x/jobs/spring-session-data-mongodb-test-jdk8/badge[link="https://ci.spring.io/teams/spring-team/pipelines/spring-session-data-mongodb-2.1.x"]
|
|
| image:https://ci.spring.io/api/v1/teams/spring-team/pipelines/spring-session-data-mongodb-2.0.x/jobs/spring-session-data-mongodb-test-jdk8/badge[link="https://ci.spring.io/teams/spring-team/pipelines/spring-session-data-mongodb-2.0.x"]
|
|
|
|
| Test - JDK 8 and Spring.NEXT (snapshots)
|
|
| image:https://ci.spring.io/api/v1/teams/spring-team/pipelines/spring-session-data-mongodb/jobs/spring-session-data-mongodb-test-jdk8-spring-next/badge[link="https://ci.spring.io/teams/spring-team/pipelines/spring-session-data-mongodb"]
|
|
| image:https://ci.spring.io/api/v1/teams/spring-team/pipelines/spring-session-data-mongodb-2.1.x/jobs/spring-session-data-mongodb-test-jdk8-spring-next/badge[link="https://ci.spring.io/teams/spring-team/pipelines/spring-session-data-mongodb-2.1.x"]
|
|
| image:https://ci.spring.io/api/v1/teams/spring-team/pipelines/spring-session-data-mongodb-2.0.x/jobs/spring-session-data-mongodb-test-jdk8-spring-next/badge[link="https://ci.spring.io/teams/spring-team/pipelines/spring-session-data-mongodb-2.0.x"]
|
|
|
|
| Test - JDK 11
|
|
| image:https://ci.spring.io/api/v1/teams/spring-team/pipelines/spring-session-data-mongodb/jobs/spring-session-data-mongodb-test-jdk11/badge[link="https://ci.spring.io/teams/spring-team/pipelines/spring-session-data-mongodb"]
|
|
| image:https://ci.spring.io/api/v1/teams/spring-team/pipelines/spring-session-data-mongodb-2.1.x/jobs/spring-session-data-mongodb-test-jdk11/badge[link="https://ci.spring.io/teams/spring-team/pipelines/spring-session-data-mongodb-2.1.x"]
|
|
| image:https://ci.spring.io/api/v1/teams/spring-team/pipelines/spring-session-data-mongodb-2.0.x/jobs/spring-session-data-mongodb-test-jdk11/badge[link="https://ci.spring.io/teams/spring-team/pipelines/spring-session-data-mongodb-2.0.x"] *
|
|
|
|
| Test - JDK 11 and Spring.NEXT (snapshots)
|
|
| image:https://ci.spring.io/api/v1/teams/spring-team/pipelines/spring-session-data-mongodb/jobs/spring-session-data-mongodb-test-jdk11-spring-next/badge[link="https://ci.spring.io/teams/spring-team/pipelines/spring-session-data-mongodb"]
|
|
| image:https://ci.spring.io/api/v1/teams/spring-team/pipelines/spring-session-data-mongodb-2.1.x/jobs/spring-session-data-mongodb-test-jdk11-spring-next/badge[link="https://ci.spring.io/teams/spring-team/pipelines/spring-session-data-mongodb-2.1.x"]
|
|
| image:https://ci.spring.io/api/v1/teams/spring-team/pipelines/spring-session-data-mongodb-2.0.x/jobs/spring-session-data-mongodb-test-jdk11-spring-next/badge[link="https://ci.spring.io/teams/spring-team/pipelines/spring-session-data-mongodb-2.0.x"] *
|
|
|
|
| Test - JDK 13*
|
|
| image:https://ci.spring.io/api/v1/teams/spring-team/pipelines/spring-session-data-mongodb/jobs/spring-session-data-mongodb-test-jdk13/badge[link="https://ci.spring.io/teams/spring-team/pipelines/spring-session-data-mongodb"] *
|
|
| image:https://ci.spring.io/api/v1/teams/spring-team/pipelines/spring-session-data-mongodb-2.1.x/jobs/spring-session-data-mongodb-test-jdk13/badge[link="https://ci.spring.io/teams/spring-team/pipelines/spring-session-data-mongodb-2.1.x"] *
|
|
| image:https://ci.spring.io/api/v1/teams/spring-team/pipelines/spring-session-data-mongodb-2.0.x/jobs/spring-session-data-mongodb-test-jdk13/badge[link="https://ci.spring.io/teams/spring-team/pipelines/spring-session-data-mongodb-2.0.x"] *
|
|
|
|
| Test - JDK 13* and Spring.NEXT (snapshots)
|
|
| image:https://ci.spring.io/api/v1/teams/spring-team/pipelines/spring-session-data-mongodb/jobs/spring-session-data-mongodb-test-jdk13-spring-next/badge[link="https://ci.spring.io/teams/spring-team/pipelines/spring-session-data-mongodb"] *
|
|
| image:https://ci.spring.io/api/v1/teams/spring-team/pipelines/spring-session-data-mongodb-2.1.x/jobs/spring-session-data-mongodb-test-jdk13-spring-next/badge[link="https://ci.spring.io/teams/spring-team/pipelines/spring-session-data-mongodb-2.1.x"] *
|
|
| image:https://ci.spring.io/api/v1/teams/spring-team/pipelines/spring-session-data-mongodb-2.0.x/jobs/spring-session-data-mongodb-test-jdk13-spring-next/badge[link="https://ci.spring.io/teams/spring-team/pipelines/spring-session-data-mongodb-2.0.x"] *
|
|
|
|
| Build - Release to repo.spring.io
|
|
| image:https://ci.spring.io/api/v1/teams/spring-team/pipelines/spring-session-data-mongodb/jobs/build/badge[link="https://ci.spring.io/teams/spring-team/pipelines/spring-session-data-mongodb"]
|
|
| image:https://ci.spring.io/api/v1/teams/spring-team/pipelines/spring-session-data-mongodb-2.1.x/jobs/build/badge[link="https://ci.spring.io/teams/spring-team/pipelines/spring-session-data-mongodb-2.1.x"]
|
|
| image:https://ci.spring.io/api/v1/teams/spring-team/pipelines/spring-session-data-mongodb-2.0.x/jobs/build/badge[link="https://ci.spring.io/teams/spring-team/pipelines/spring-session-data-mongodb-2.0.x"]
|
|
|
|
| _* Not officially supported_
|
|
|
|
|
|
|
|
|
|
|
|===
|
|
|
|
[IMPORTANT]
|
|
====
|
|
* Spring Session for MongoDB 2.2 runs on Spring Framework 5.2.
|
|
* Spring Session for MongoDB 2.1 runs on Spring Framework 5.1.
|
|
|
|
Both of these have support for *JDK 11*.
|
|
|
|
Spring Session for MongoDB *2.0* runs on Spring Framework 5.0 and is NOT supported on *JDK 11* despite
|
|
our pipelines testing against it. The extra tests are designed to give you a smooth upgrade path. If you are going into production on
|
|
JDK 11, you should be using at least Spring Session for MongoDB *2.1*.
|
|
====
|
|
|
|
IMPORTANT: *JDK 13* is Java's latest version and is unstable. We are testing against it to catch issues early on, but don't support it directly on any version of Spring Session for MongoDB.
|
|
|
|
== Building Spring Session MongoDB
|
|
|
|
. Run `mvn clean package`
|
|
|
|
This will generate the artifact.
|
|
|
|
You can also import the project into your IDE.
|
|
|
|
== Code of Conduct
|
|
This project adheres to the Contributor Covenant link:CODE_OF_CONDUCT.adoc[code of conduct].
|
|
By participating, you are expected to uphold this code. Please report unacceptable behavior to spring-code-of-conduct@pivotal.io.
|
|
|
|
= Spring Session Project Site
|
|
|
|
You can find the documentation, issue management, support, samples, and guides for using Spring Session MongoDB at https://projects.spring.io/spring-session-data-mongodb/
|
|
|
|
= License
|
|
|
|
Spring Session is Open Source software released under the https://www.apache.org/licenses/LICENSE-2.0.html[Apache 2.0 license].
|