org.jooby.mongodb

Class MongoSessionStore

java.lang.Object

org.jooby.mongodb.MongoSessionStore

All Implemented Interfaces:

Session.Store

public class MongoSessionStore
extends Object
implements Session.Store

A Session.Store powered by Mongodb.

usage

 {
   use(new Mongodb());

   session(MongoSessionStore.class);

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

The name attribute and value will be stored in a Mongodb.

options

timeout

By default, a mongodb 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
 

It uses MongoDB's TTL collection feature (2.2+) to have mongod automatically remove expired sessions.

If no timeout is required, use -1.

session collection

Default mongodb collection is sessions.

It's possible to change the default key setting the mongodb.sesssion.collection properties.

Since:

0.5.0

Author:

edgar

Field Summary

Fields inherited from interface org.jooby.Session.Store

rnd

Constructor Summary

Constructors

Constructor and Description
MongoSessionStore(com.mongodb.client.MongoDatabase db, String collection, long timeoutInSeconds)
MongoSessionStore(com.mongodb.client.MongoDatabase db, String collection, String timeout)

Method Summary

Modifier and Type	Method and Description
void	create(Session session)
void	delete(String id) Delete a session by ID.
Session	get(Session.Builder builder) Get a session by ID (if any).
void	save(Session session) Save/persist a session.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.jooby.Session.Store

generateID

Constructor Detail

MongoSessionStore

public MongoSessionStore(com.mongodb.client.MongoDatabase db,
                         String collection,
                         long timeoutInSeconds)

MongoSessionStore

@Inject
public MongoSessionStore(com.mongodb.client.MongoDatabase db,
                                 @Named(value="mongodb.session.collection")
                                 String collection,
                                 @Named(value="session.timeout")
                                 String timeout)

Method Detail

get

public Session get(Session.Builder builder)

Description copied from interface: Session.Store

Get a session by ID (if any).

Specified by:

get in interface Session.Store

Parameters:

builder - A session builder.

Returns:

A session or null.

save

public void save(Session session)

Description copied from interface: Session.Store

Save/persist a session.

Specified by:

save in interface Session.Store

Parameters:

session - A session to be persisted.

create

public void create(Session session)

Specified by:

create in interface Session.Store

delete

public void delete(String id)

Description copied from interface: Session.Store

Delete a session by ID.

Specified by:

delete in interface Session.Store

Parameters:

id - A session ID.