SessionStore (jooby 2.16.2 API)

All Known Implementing Classes:

MemorySessionStore, SessionStore.InMemory, SignedSessionStore
```
public interface SessionStore
```
Load and save sessions from store (memory, database, etc.).

Since:

2.0.0

Author:

edgar

Nested Class Summary

Nested Classes
Modifier and Type Interface and Description

static class SessionStore.InMemory
Base class for in-memory session store.

Nested Classes
Modifier and Type	Interface and Description
`static class`	`SessionStore.InMemory` Base class for in-memory session store.

Field Summary

Fields
Modifier and Type Field and Description

static int DEFAULT_TIMEOUT
Default session timeout in minutes.

Fields
Modifier and Type	Field and Description
`static int`	`DEFAULT_TIMEOUT` Default session timeout in minutes.

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method and Description
`void`	`deleteSession(Context ctx, Session session)` Delete a session from store.
`Session`	`findSession(Context ctx)` Find an existing session by ID.
`static SessionStore`	`memory()` Creates a cookie based session and store data in memory.
`static SessionStore`	`memory(Cookie cookie)` Creates a cookie based session and store data in memory.
`static SessionStore`	`memory(Cookie cookie, Duration timeout)` Creates a cookie based session and store data in memory.
`static SessionStore`	`memory(Duration timeout)` Creates a cookie based session and store data in memory.
`static SessionStore`	`memory(int timeout)` Creates a cookie based session and store data in memory.
`static SessionStore`	`memory(SessionToken token)` Creates a session store that save data in memory.
`static SessionStore`	`memory(SessionToken token, Duration timeout)` Creates a session store that save data in memory.
`Session`	`newSession(Context ctx)` Creates a new session.
`void`	`renewSessionId(Context ctx, Session session)` Renew Session ID.
`void`	`saveSession(Context ctx, Session session)` Save a session.
`static SessionStore`	`signed(SessionToken token, Function<String,Map<String,String>> decoder, Function<Map<String,String>,String> encoder)` Creates a session store that save data into Cookie.
`static SessionStore`	`signed(String secret)` Creates a session store that uses (un)signed data.
`static SessionStore`	`signed(String secret, Cookie cookie)` Creates a session store that uses (un)signed data.
`static SessionStore`	`signed(String secret, SessionToken token)` Creates a session store that uses (un)signed data.
`void`	`touchSession(Context ctx, Session session)` Session attributes/state has changed.

- Field Detail
  - DEFAULT_TIMEOUT
```
static final int DEFAULT_TIMEOUT
```
    Default session timeout in minutes.
    
    See Also:
    
    Constant Field Values
- Method Detail
  - newSession
```
@Nonnull
Session newSession(@Nonnull
                            Context ctx)
```
    Creates a new session. This method must: - Set session as new Session.setNew(boolean) - Optionally, set session creation time Session.setCreationTime(Instant) - Optionally, set session last accessed time Session.setLastAccessedTime(Instant)
    
    Parameters:
    
    ctx - Web context.
    
    Returns:
    
    A new session.
  - findSession
```
@Nullable
Session findSession(@Nonnull
                              Context ctx)
```
    Find an existing session by ID. For existing session this method must: - Optionally, Retrieve/restore session creation time - Optionally, Set session last accessed time Session.setLastAccessedTime(Instant)
    
    Parameters:
    
    ctx - Web context.
    
    Returns:
    
    An existing session or null.
  - deleteSession
```
void deleteSession(@Nonnull
                   Context ctx,
                   @Nonnull
                   Session session)
```
    Delete a session from store. This method must NOT call Session.destroy().
    
    Parameters:
    
    ctx - Web context.
    
    session - Current session.
  - touchSession
```
void touchSession(@Nonnull
                  Context ctx,
                  @Nonnull
                  Session session)
```
    Session attributes/state has changed. Every time a session attribute is put or removed it, this method is executed as notification callback.
    
    Parameters:
    
    ctx - Web context.
    
    session - Current session.
  - saveSession
```
void saveSession(@Nonnull
                 Context ctx,
                 @Nonnull
                 Session session)
```
    Save a session. This method must save: - Session attributes/data - Optionally set Session metadata like: creationTime, lastAccessed time, etc. This method is call after response is send to client, so context and response shouldn't be modified.
    
    Parameters:
    
    ctx - Web context.
    
    session - Current session.
  - renewSessionId
```
void renewSessionId(@Nonnull
                    Context ctx,
                    @Nonnull
                    Session session)
```
    Renew Session ID. This operation might or might not be implemented by a Session Store.
    
    Parameters:
    
    ctx - Web Context.
    
    session - Session.
  - memory
```
@Nonnull
static SessionStore memory(int timeout)
```
    Creates a cookie based session and store data in memory. Session data is not keep after restart. It uses the default session cookie: SessionToken.SID. - Session data is not keep after restart.
    
    Parameters:
    
    timeout - Timeout in seconds. Use -1 for no timeout.
    
    Returns:
    
    Session store.
  - memory
```
@Nonnull
static SessionStore memory()
```
    Creates a cookie based session and store data in memory. Session data is not keep after restart. It uses the default session cookie: SessionToken.SID. - Session expires after 30 minutes of inactivity. - Session data is not keep after restart.
    
    Returns:
    
    Session store.
  - memory
```
@Nonnull
static SessionStore memory(@Nonnull
                                    Duration timeout)
```
    Creates a cookie based session and store data in memory. Session data is not keep after restart. It uses the default session cookie: SessionToken.SID.
    
    Parameters:
    
    timeout - Expires session after amount of inactivity time.
    
    Returns:
    
    Session store.
  - memory
```
@Nonnull
static SessionStore memory(@Nonnull
                                    Cookie cookie)
```
    Creates a cookie based session and store data in memory. - Session expires after 30 minutes of inactivity. - Session data is not keep after restart.
    
    Parameters:
    
    cookie - Cookie to use.
    
    Returns:
    
    Session store.
  - memory
```
@Nonnull
static SessionStore memory(@Nonnull
                                    Cookie cookie,
                                    @Nonnull
                                    Duration timeout)
```
    Creates a cookie based session and store data in memory. Session data is not keep after restart.
    
    Parameters:
    
    cookie - Cookie to use.
    
    timeout - Expires session after amount of inactivity time.
    
    Returns:
    
    Session store.
  - memory
```
@Nonnull
static SessionStore memory(@Nonnull
                                    SessionToken token)
```
    Creates a session store that save data in memory. - Session expires after 30 minutes of inactivity. - Session data is not keep after restart.
    
    Parameters:
    
    token - Session token.
    
    Returns:
    
    Session store.
  - memory
```
@Nonnull
static SessionStore memory(@Nonnull
                                    SessionToken token,
                                    @Nonnull
                                    Duration timeout)
```
    Creates a session store that save data in memory. Session data is not keep after restart.
    
    Parameters:
    
    token - Session token.
    
    timeout - Expires session after amount of inactivity time.
    
    Returns:
    
    Session store.
  - signed
```
@Nonnull
static SessionStore signed(@Nonnull
                                    String secret)
```
    Creates a session store that uses (un)signed data. Session data is signed it using HMAC_SHA256. See Cookie.sign(String, String) and Cookie.unsign(String, String).
    
    Parameters:
    
    secret - Secret token to signed data.
    
    Returns:
    
    A browser session store.
  - signed
```
@Nonnull
static SessionStore signed(@Nonnull
                                    String secret,
                                    @Nonnull
                                    Cookie cookie)
```
    Creates a session store that uses (un)signed data. Session data is signed it using HMAC_SHA256. See Cookie.sign(String, String) and Cookie.unsign(String, String).
    
    Parameters:
    
    secret - Secret token to signed data.
    
    cookie - Cookie to use.
    
    Returns:
    
    A browser session store.
  - signed
```
@Nonnull
static SessionStore signed(@Nonnull
                                    String secret,
                                    @Nonnull
                                    SessionToken token)
```
    Creates a session store that uses (un)signed data. Session data is signed it using HMAC_SHA256. See Cookie.sign(String, String) and Cookie.unsign(String, String).
    
    Parameters:
    
    secret - Secret token to signed data.
    
    token - Session token to use.
    
    Returns:
    
    A browser session store.
  - signed
```
@Nonnull
static SessionStore signed(@Nonnull
                                    SessionToken token,
                                    @Nonnull
                                    Function<String,Map<String,String>> decoder,
                                    @Nonnull
                                    Function<Map<String,String>,String> encoder)
```
    Creates a session store that save data into Cookie. Cookie data is (un)signed it using the given decoder and encoder.
    
    Parameters:
    
    token - Token to use.
    
    decoder - Decoder to use.
    
    encoder - Encoder to use.
    
    Returns:
    
    Cookie session store.

Interface SessionStore

Nested Class Summary

Field Summary

Method Summary

Field Detail

DEFAULT_TIMEOUT

Method Detail

newSession

findSession

deleteSession

touchSession

saveSession

renewSessionId

memory

memory

memory

memory

memory

memory

memory

signed

signed

signed

signed