org.jooby.jedis

Class RedisSessionStore

java.lang.Object

org.jooby.jedis.RedisSessionStore

All Implemented Interfaces:

Session.Store

@Singleton
public class RedisSessionStore
extends Object
implements Session.Store

A Session.Store powered by Redis.

usage

 {
   use(new Redis());

   session(RedisSessionStore.class);

   get("/", req  -> {
    req.session().set("name", "jooby");
   });
 }
 

The name attribute and value will be stored in a Redis db. Session are persisted as a Redis Hash.

options

timeout

By default, a redis session will expire after 30 minutes. Changing the default timeout is as simple as:

 # 8 hours
 session.timeout = 8h

 # 15 seconds
 session.timeout = 15

 # 120 minutes
 session.timeout = 120m

 # no timeout
 session.timeout = -1
 

key prefix

Default redis key prefix is sessions. Sessions in redis will look like: sessions:ID

It's possible to change the default key setting the jedis.sesssion.prefix properties

Since:

0.5.0

Author:

edgar

Constructor Summary

Constructors

Constructor and Description
RedisSessionStore(redis.clients.jedis.JedisPool pool, String prefix, int timeout) Creates a new RedisSessionStore.
RedisSessionStore(redis.clients.jedis.JedisPool pool, String prefix, String timeout) Creates a new RedisSessionStore.

Method Summary

Modifier and Type	Method and Description
void	create(Session session)
void	delete(String id)
Session	get(Session.Builder builder)
void	save(Session session)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.jooby.Session.Store

generateID

Constructor Detail

RedisSessionStore

public RedisSessionStore(redis.clients.jedis.JedisPool pool,
                         String prefix,
                         int timeout)

Creates a new RedisSessionStore.

Parameters:

pool - Jedis pool.

prefix - Session key prefix on redis.

timeout - Session timeout in seconds.

RedisSessionStore

@Inject
public RedisSessionStore(redis.clients.jedis.JedisPool pool,
                                 @Named(value="jedis.session.prefix")
                                 String prefix,
                                 @Named(value="jedis.session.timeout")
                                 String timeout)

Creates a new RedisSessionStore.

Parameters:

pool - Jedis pool.

prefix - Session key prefix on redis.

timeout - Session timeout expression, like 30m.

Method Detail

get

public Session get(Session.Builder builder)

Specified by:

get in interface Session.Store

save

public void save(Session session)

Specified by:

save in interface Session.Store

create

public void create(Session session)

Specified by:

create in interface Session.Store

delete

public void delete(String id)

Specified by:

delete in interface Session.Store