Merge pull request #2041 from apemost/fix-readme

Improve syntax highlighting
pull/2085/head
Nikita Koksharov 6 years ago committed by GitHub
commit 6e517726ff
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

@ -1,5 +1,4 @@
Redis based Hibernate Cache implementation # Redis based Hibernate Cache implementation
===
Implements [Hibernate 2nd level Cache](https://docs.jboss.org/hibernate/orm/5.4/userguide/html_single/Hibernate_User_Guide.html#caching) provider based on Redis. Implements [Hibernate 2nd level Cache](https://docs.jboss.org/hibernate/orm/5.4/userguide/html_single/Hibernate_User_Guide.html#caching) provider based on Redis.
Supports all Hibernate cache strategies: `READ_ONLY`, `NONSTRICT_READ_WRITE`, `READ_WRITE` and `TRANSACTIONAL`. Supports all Hibernate cache strategies: `READ_ONLY`, `NONSTRICT_READ_WRITE`, `READ_WRITE` and `TRANSACTIONAL`.
@ -22,12 +21,12 @@ Below is the list of all available factories with local cache and/or data partit
|RedissonClusteredRegionFactory<br/><sub><i>available only in [Redisson PRO](http://redisson.pro) edition</i></sub> | No | **Yes** | |RedissonClusteredRegionFactory<br/><sub><i>available only in [Redisson PRO](http://redisson.pro) edition</i></sub> | No | **Yes** |
|RedissonClusteredLocalCachedRegionFactory<br/><sub><i>available only in [Redisson PRO](http://redisson.pro) edition</i></sub> | **Yes** | **Yes** | |RedissonClusteredLocalCachedRegionFactory<br/><sub><i>available only in [Redisson PRO](http://redisson.pro) edition</i></sub> | **Yes** | **Yes** |
Hibernate Cache Usage ## Hibernate Cache Usage
===
### 1. Add `redisson-hibernate` dependency into your project: ### 1. Add `redisson-hibernate` dependency into your project:
Maven Maven
```xml ```xml
<dependency> <dependency>
<groupId>org.redisson</groupId> <groupId>org.redisson</groupId>
@ -45,7 +44,7 @@ Maven
Gradle Gradle
```java ```groovy
// for Hibernate v4.x // for Hibernate v4.x
compile 'org.redisson:redisson-hibernate-4:3.10.6' compile 'org.redisson:redisson-hibernate-4:3.10.6'
// for Hibernate v5.0.x - v5.1.x // for Hibernate v5.0.x - v5.1.x
@ -56,7 +55,6 @@ Gradle
compile 'org.redisson:redisson-hibernate-53:3.10.6' compile 'org.redisson:redisson-hibernate-53:3.10.6'
``` ```
### 2. Specify hibernate cache settings ### 2. Specify hibernate cache settings
Define Redisson Region Cache Factory: Define Redisson Region Cache Factory:
@ -71,7 +69,9 @@ Define Redisson Region Cache Factory:
<!-- or --> <!-- or -->
<property name="hibernate.cache.region.factory_class" value="org.redisson.hibernate.RedissonClusteredLocalCachedRegionFactory" /> <property name="hibernate.cache.region.factory_class" value="org.redisson.hibernate.RedissonClusteredLocalCachedRegionFactory" />
``` ```
By default each Region Factory creates own Redisson instance. For multiple applications, using the same Redis setup and deployed in the same JVM, amount of Redisson instances could be reduced using JNDI registry: By default each Region Factory creates own Redisson instance. For multiple applications, using the same Redis setup and deployed in the same JVM, amount of Redisson instances could be reduced using JNDI registry:
```xml ```xml
<!-- name of Redisson instance registered in JNDI --> <!-- name of Redisson instance registered in JNDI -->
<property name="hibernate.cache.region.jndi_name" value="redisson_instance" /> <property name="hibernate.cache.region.jndi_name" value="redisson_instance" />

@ -1,5 +1,4 @@
Spring Boot Starter # Spring Boot Starter
===
Integrates Redisson with Spring Boot library. Depends on [Spring Data Redis](https://github.com/redisson/redisson/tree/master/redisson-spring-data#spring-data-redis-integration) module. Integrates Redisson with Spring Boot library. Depends on [Spring Data Redis](https://github.com/redisson/redisson/tree/master/redisson-spring-data#spring-data-redis-integration) module.
@ -7,10 +6,9 @@ Supports Spring Boot 1.3.x, 1.4.x, 1.5.x, 2.0.x, 2.1.x
<sub>Consider __[Redisson PRO](https://redisson.pro)__ version for advanced features and support by SLA.</sub> <sub>Consider __[Redisson PRO](https://redisson.pro)__ version for advanced features and support by SLA.</sub>
Usage ## Usage
===
### 1. Add `redisson-spring-boot-starter` dependency into your project: ### 1. Add `redisson-spring-boot-starter` dependency into your project:
Maven Maven
@ -23,7 +21,8 @@ Maven
``` ```
Gradle Gradle
```java
```groovy
compile 'org.redisson:redisson-spring-boot-starter:3.10.6' compile 'org.redisson:redisson-spring-boot-starter:3.10.6'
``` ```

@ -1,5 +1,4 @@
Spring Data Redis integration # Spring Data Redis integration
===
Integrates Redisson with Spring Data Redis library. Implements Spring Data's `RedisConnectionFactory` and `ReactiveRedisConnectionFactory` interfaces and allows to interact with Redis through `RedisTemplate` or `ReactiveRedisTemplate` object. Integrates Redisson with Spring Data Redis library. Implements Spring Data's `RedisConnectionFactory` and `ReactiveRedisConnectionFactory` interfaces and allows to interact with Redis through `RedisTemplate` or `ReactiveRedisTemplate` object.
@ -7,10 +6,9 @@ Supports Spring Data Redis 1.6.x, 1.7.x, 1.8.x, 2.0.x, 2.1.x
<sub>Consider __[Redisson PRO](https://redisson.pro)__ version for advanced features and support by SLA.</sub> <sub>Consider __[Redisson PRO](https://redisson.pro)__ version for advanced features and support by SLA.</sub>
Usage ## Usage
===
### 1. Add `redisson-spring-data` dependency into your project: ### 1. Add `redisson-spring-data` dependency into your project:
Maven Maven
@ -33,7 +31,7 @@ Maven
Gradle Gradle
```java ```groovy
// for Spring Data Redis v.1.6.x // for Spring Data Redis v.1.6.x
compile 'org.redisson:redisson-spring-data-16:3.10.6' compile 'org.redisson:redisson-spring-data-16:3.10.6'
// for Spring Data Redis v.1.7.x // for Spring Data Redis v.1.7.x

@ -1,5 +1,4 @@
Redis based Tomcat Session Manager # Redis based Tomcat Session Manager
===
Stores session of [Apache Tomcat](http://tomcat.apache.org) in Redis and allows to distribute requests across a cluster of Tomcat servers. Implements non-sticky session management backed by Redis. Stores session of [Apache Tomcat](http://tomcat.apache.org) in Redis and allows to distribute requests across a cluster of Tomcat servers. Implements non-sticky session management backed by Redis.
@ -7,13 +6,11 @@ Supports Apache Tomcat 6.x, 7.x, 8.x, 9.x
<sub>Consider __[Redisson PRO](https://redisson.pro)__ version for advanced features and support by SLA.</sub> <sub>Consider __[Redisson PRO](https://redisson.pro)__ version for advanced features and support by SLA.</sub>
Advantages ## Advantages
===
Current implementation differs from any other Redis based Tomcat Session Manager in terms of efficient storage and optimized writes. Each session attribute is written into Redis during each `HttpSession.setAttribute` invocation. While other solutions serialize whole session each time. Current implementation differs from any other Redis based Tomcat Session Manager in terms of efficient storage and optimized writes. Each session attribute is written into Redis during each `HttpSession.setAttribute` invocation. While other solutions serialize whole session each time.
Usage ## Usage
===
### 1. Add `RedissonSessionManager` ### 1. Add `RedissonSessionManager`
@ -68,6 +65,7 @@ Add `RedissonSessionManager` into `tomcat/conf/context.xml`
### 2. Copy two jars into `TOMCAT_BASE/lib` directory: ### 2. Copy two jars into `TOMCAT_BASE/lib` directory:
[redisson-all-3.10.7.jar](https://repository.sonatype.org/service/local/artifact/maven/redirect?r=central-proxy&g=org.redisson&a=redisson-all&v=3.10.7&e=jar) [redisson-all-3.10.7.jar](https://repository.sonatype.org/service/local/artifact/maven/redirect?r=central-proxy&g=org.redisson&a=redisson-all&v=3.10.7&e=jar)
for Tomcat 6.x for Tomcat 6.x

Loading…
Cancel
Save