org.jooby.couchbase

Class CouchbaseSessionStore

java.lang.Object

org.jooby.couchbase.CouchbaseSessionStore

All Implemented Interfaces:

Session.Store

public class CouchbaseSessionStore
extends Object
implements Session.Store

couchbase session store

A Session.Store powered by Couchbase.

usage

 {
   use(new Couchbase("couchbase://localhost/bucket"));

   session(CouchbaseSessionStore.class);

   get("/", req -> {
     Session session = req.session();
     session.put("foo", "bar");

     ..
   });
 }
 

Session data is persisted in Couchbase and document looks like:

 {
   "session::{SESSION_ID}": {
     "foo": "bar"
   }
 }
 

options

timeout

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

Expiration is done via Couchbase expiry/ttl option.

If no timeout is required, use -1.

custom bucket

The session document are persisted in the application/default bucket, if you need/want a different bucket then use Couchbase.sessionBucket(String), like:

 {
   use(
       new Couchbase("couchbase://localhost/myapp")
           .sessionBucket("session")
   );
 }
 

Since:

1.0.0.CR7

Author:

edgar

Field Summary

Fields inherited from interface org.jooby.Session.Store

rnd

Constructor Summary

Constructors

Constructor and Description
CouchbaseSessionStore(com.couchbase.client.java.Bucket bucket, int timeout)
CouchbaseSessionStore(com.couchbase.client.java.Bucket bucket, 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

CouchbaseSessionStore

public CouchbaseSessionStore(com.couchbase.client.java.Bucket bucket,
                             int timeout)

CouchbaseSessionStore

@Inject
public CouchbaseSessionStore(@Named(value="session")
                                     com.couchbase.client.java.Bucket bucket,
                                     @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.