Compare commits

...

12 Commits

Author SHA1 Message Date
Ranjith Manickam d0de8bb6e2
Update README.md 2020-12-23 13:00:58 +05:30
Ranjith Manickam 8593f88243 update downloads badge 2020-12-23 12:50:14 +05:30
Ranjith Manickam 9da24f2328 Add maven repo 2020-12-23 12:38:24 +05:30
Ranjith Manickam e31ea59636 Add maven repo 2020-12-23 12:28:11 +05:30
Ranjith Manickam 45b0b98725
Update README.md 2020-11-08 09:58:03 +05:30
Ranjith Manickam 2e505deee1
Update README.md 2020-05-15 16:11:45 +05:30
Ranjith Manickam df80fa0da3
Update README.md 2020-05-13 11:10:57 +05:30
Ranjith Manickam f4c6322793
Update pom.xml 2020-05-13 11:08:04 +05:30
Ranjith Manickam a0eab9407e version update 2020-05-13 11:03:04 +05:30
Ranjith Manickam 1f6e57c164 Fix for - NPE in SessionHandlerValve.java accessing Tomcat's /manager app 2020-05-13 11:02:21 +05:30
Ranjith Manickam 5d0c7aa7a1 Update README.md 2020-05-02 14:53:18 +05:30
Ranjith Manickam 3916e217a5
Update pom.xml 2020-05-02 14:45:13 +05:30
4 changed files with 57 additions and 18 deletions

View File

@ -14,15 +14,31 @@ Going forward, we no need to enable sticky session (JSESSIONID) in Load Balancer
- Apache Tomcat 7
- Apache Tomcat 8
- Apache Tomcat 9
- Apache Tomcat 10
## Downloads: [![Total Downloads](https://get-badge.herokuapp.com/ran-jit/tomcat-cluster-redis-session-manager/total)](https://github.com/ran-jit/tomcat-cluster-redis-session-manager/wiki)
- [latest version (3.0.4)](https://github.com/ran-jit/tomcat-cluster-redis-session-manager/releases/tag/3.0.4)
## Downloads: [![Total Downloads](https://img.shields.io/github/downloads/ran-jit/tomcat-cluster-redis-session-manager/total.svg)](https://github.com/ran-jit/tomcat-cluster-redis-session-manager/wiki)
- [latest version (4.0)](https://github.com/ran-jit/tomcat-cluster-redis-session-manager/releases/tag/4.0)
- [older versions](https://github.com/ran-jit/tomcat-cluster-redis-session-manager/wiki)
<p align="center">
<a href="https://paypal.me/ranmanic1" target="_blank"><img alt="Donate" height="30%" width="30%" src="https://github.com/ran-jit/tomcat-cluster-redis-session-manager/blob/master/src/main/resources/donate.png"></a>
<a href="https://www.buymeacoffee.com/ranmanic" target="_blank"><img src="https://cdn.buymeacoffee.com/buttons/v2/default-red.png" alt="Buy Me A Coffee" style="height: 60px !important;width: 217px !important;" ></a>
</p>
## Maven configuration
```
<repository>
<id>repsy</id>
<name>tomcat-cluster-redis-session-manager-repo</name>
<url>https://repo.repsy.io/mvn/ranmanic/tomcat-session-manager</url>
</repository>
<dependency>
<groupId>tomcat-session-manager</groupId>
<artifactId>redis</artifactId>
<version>4.0</version>
</dependency>
```
#### Pre-requisite:
1. jedis.jar
2. commons-pool2.jar
@ -33,23 +49,33 @@ more details.. https://github.com/ran-jit/tomcat-cluster-redis-session-manager/w
#### Steps to be done,
1. Copy the downloaded jars to your tomcat/lib directory.
- **tomcat/lib/**
```
tomcat/lib/
```
2. Add tomcat system property "catalina.base".
- **catalina.base="TOMCAT_LOCATION"**
* example: env "catalina.base=/opt/tomcat" bash
```
catalina.base="TOMCAT_LOCATION"
example: env "catalina.base=/opt/tomcat" bash
```
3. Copy the redis-data-cache.properties file to your tomcat/conf directory and update your Redis server details.
- **tomcat/conf/redis-data-cache.properties**
```
tomcat/conf/redis-data-cache.properties
```
4. Add the below two lines in your tomcat/conf/context.xml file.
- **&#60;Valve className="tomcat.request.session.redis.SessionHandlerValve" &#47;&#62;**
- **&#60;Manager className="tomcat.request.session.redis.SessionManager" &#47;&#62;**
```
<Valve className="tomcat.request.session.redis.SessionHandlerValve" />
<Manager className="tomcat.request.session.redis.SessionManager" />
```
5. Verify the session expiration time in tomcat/conf/web.xml file.
- **&#60;session-config&#62;**
- &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; **&#60;session-timeout&#62;60&#60;&#47;session-timeout&#62;**
- **&#60;&#47;session-config&#62;**
```
<session-config>
<session-timeout>60</session-timeout>
</session-config>
```
### Note:
- **All your session attribute values must implement java.io.Serializable.**
@ -67,7 +93,8 @@ more details.. https://github.com/ran-jit/tomcat-cluster-redis-session-manager/w
<tr><td>redis.sentinel.enabled</td><td>To enable redis sentinel mode<br/>- default: false<br>- supported values: true/false</td></tr>
<tr><td>redis.sentinel.master</td><td>Redis sentinel master name<br/>- default: mymaster</td></tr>
<tr><td>lb.sticky-session.enabled</td><td>To enable redis and standard session mode<br><br>If enabled,<ol><li>Must be enabled sticky session in your load balancer configuration. Else this manager may not return the updated session values</li><li>Session values are stored in local jvm and redis</li><li>If redis is down/not responding, requests uses jvm stored session values to process user requests. Redis comes back the values will be synced</li></ol>- default: false</td></tr>
<tr><td>session.persistent.policies</td><td>session persistent policies.<br/><br/>- policies - DEFAULT, SAVE_ON_CHANGE, ALWAYS_SAVE_AFTER_REQUEST <br/><ol><li>SAVE_ON_CHANGE: every time session.setAttribute() or session.removeAttribute() is called the session will be saved.</li><li>ALWAYS_SAVE_AFTER_REQUEST: force saving after every request, regardless of whether or not the manager has detected changes to the session.</li></ol>- default: DEFAULT</td></tr>
<tr><td>session.persistent.policies</td><td>session persistent policies.<br/><br/>- policies - DEFAULT, SAVE_ON_CHANGE, ALWAYS_SAVE_AFTER_REQUEST <br/><ol><li>SAVE_ON_CHANGE: every time session.setAttribute() or session.removeAttribute() is called the session will be saved.</li><li>ALWAYS_SAVE_AFTER_REQUEST: force saving after every request, regardless of whether or not the manager has detected changes to the session.</li></ol>- default: DEFAULT</td></tr>
<tr><td>redis.sso.timeout</td><td>single-sign-on session timeout.<br/>- default: 0 ms (-no expiry)</td></tr>
</table>
</body>
</html>

14
pom.xml
View File

@ -2,9 +2,9 @@
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
<modelVersion>4.0.0</modelVersion>
<groupId>tomcat-cluster-redis-session-manager</groupId>
<artifactId>tomcat-cluster-redis-session-manager</artifactId>
<version>3.0.5</version>
<groupId>tomcat-session-manager</groupId>
<artifactId>redis</artifactId>
<version>4.0</version>
<packaging>jar</packaging>
<name>tomcat-cluster-redis-session-manager</name>
@ -36,6 +36,14 @@
<!-- For local development properties end.. -->
</properties>
<distributionManagement>
<repository>
<id>repsy</id>
<name>tomcat-cluster-redis-session-manager-repo</name>
<url>https://repo.repsy.io/mvn/ranmanic/tomcat-session-manager</url>
</repository>
</distributionManagement>
<dependencies>
<dependency>
<groupId>redis.clients</groupId>

View File

@ -31,7 +31,9 @@ public class SessionHandlerValve extends ValveBase {
LOGGER.error("Error processing request", ex);
throw new BackendException();
} finally {
this.manager.afterRequest();
if (this.manager != null) {
this.manager.afterRequest();
}
}
}
}

View File

@ -225,7 +225,9 @@ public class SingleSignOnValve extends SingleSignOn {
/** To set session manager. */
void setSessionManager(Manager manager) {
this.manager = (SessionManager) manager;
if (manager != null) {
this.manager = (SessionManager) manager;
}
}
/** To expire session. */