Module io.jooby.jwt

Package io.jooby.jwt

Class JwtSessionStore

java.lang.Object

io.jooby.jwt.JwtSessionStore

All Implemented Interfaces:

SessionStore

public class JwtSessionStore
extends Object
implements SessionStore

A HTTP cookie session store using JSON Web Token. Usage:

 {
   String key = "256 bit key"
   setSessionStore(new JwtSession(key));
 }
 

It uses HMAC-SHA-256 for signing the cookie. Secret key and cookie option can be specify programmatically or in your application configuration file.

This session store delegates to SessionStore.signed(SessionToken, Function, Function) using JSON Web Token library.

Since:

2.2.0

Author:

edgar

Nested Class Summary

Nested classes/interfaces inherited from interface io.jooby.SessionStore

SessionStore.InMemory

Field Summary

Fields inherited from interface io.jooby.SessionStore

DEFAULT_TIMEOUT

Constructor Summary

Constructors

Constructor	Description
JwtSessionStore(String key)	Creates a JSON Web Token session store.
JwtSessionStore(String key, SessionToken token)	Creates a JSON Web Token session store.
JwtSessionStore(Key key, SessionToken token)	Creates a JSON Web Token session store.

Method Summary

Modifier and Type	Method	Description
void	deleteSession(Context ctx, Session session)
Session	findSession(Context ctx)
Session	newSession(Context ctx)
void	renewSessionId(Context ctx, Session session)
void	saveSession(Context ctx, Session session)
void	touchSession(Context ctx, Session session)

Methods inherited from class java.lang.Object

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

Constructor Details

JwtSessionStore

public JwtSessionStore(@NonNull
 String key)

Creates a JSON Web Token session store. It uses a cookie token: SessionToken.SID.

Parameters:

key - Secret key.

JwtSessionStore

public JwtSessionStore(@NonNull
 String key,
 @NonNull
 SessionToken token)

Creates a JSON Web Token session store. Session token is usually a SessionToken.signedCookie(Cookie), SessionToken.header(String) or combination of both.

Parameters:

key - Secret key.

token - Session token.

JwtSessionStore

public JwtSessionStore(@NonNull
 Key key,
 @NonNull
 SessionToken token)

Creates a JSON Web Token session store. Session token is usually a SessionToken.signedCookie(Cookie), SessionToken.header(String) or combination of both.

Parameters:

key - Secret key.

token - Session token.

Method Details

newSession

@NonNull
public Session newSession(@NonNull
 Context ctx)

Specified by:

newSession in interface SessionStore

findSession

@Nullable
public Session findSession(@NonNull
 Context ctx)

Specified by:

findSession in interface SessionStore

deleteSession

public void deleteSession(@NonNull
 Context ctx,
 @NonNull
 Session session)

Specified by:

deleteSession in interface SessionStore

touchSession

public void touchSession(@NonNull
 Context ctx,
 @NonNull
 Session session)

Specified by:

touchSession in interface SessionStore

saveSession

public void saveSession(@NonNull
 Context ctx,
 @NonNull
 Session session)

Specified by:

saveSession in interface SessionStore

renewSessionId

public void renewSessionId(@NonNull
 Context ctx,
 @NonNull
 Session session)

Specified by:

renewSessionId in interface SessionStore