org.pac4j.core.context.session

Interface SessionStore<C extends WebContext>

All Known Implementing Classes:

J2ESessionStore

public interface SessionStore<C extends WebContext>

To store data in session.

Since:

1.8.1

Author:

Jerome Leleu

Method Summary

Modifier and Type	Method and Description
SessionStore<C>	buildFromTrackableSession(C context, java.lang.Object trackableSession) Build a new session store from a trackable session.
boolean	destroySession(C context) Destroy the web session.
java.lang.Object	get(C context, java.lang.String key) Get the object from its key in store.
java.lang.String	getOrCreateSessionId(C context) Get or create the session identifier and initialize the session with it if necessary.
java.lang.Object	getTrackableSession(C context) Get the native session as a trackable object.
boolean	renewSession(C context) Renew the native session by copying all data to a new one.
void	set(C context, java.lang.String key, java.lang.Object value) Save an object in the store by its key.

Method Detail

getOrCreateSessionId

java.lang.String getOrCreateSessionId(C context)

Get or create the session identifier and initialize the session with it if necessary.

Parameters:

context - the web context

Returns:

the session identifier

get

java.lang.Object get(C context,
                     java.lang.String key)

Get the object from its key in store.

Parameters:

context - the web context

key - the key of the object

Returns:

the object in store

set

void set(C context,
         java.lang.String key,
         java.lang.Object value)

Save an object in the store by its key.

Parameters:

context - the web context

key - the key of the object

value - the value to save in store

destroySession

boolean destroySession(C context)

Destroy the web session.

Parameters:

context - the web context

Returns:

whether the session has been destroyed

getTrackableSession

java.lang.Object getTrackableSession(C context)

Get the native session as a trackable object.

Parameters:

context - the web context

Returns:

the trackable object or null if this is not supported

buildFromTrackableSession

SessionStore<C> buildFromTrackableSession(C context,
                                          java.lang.Object trackableSession)

Build a new session store from a trackable session.

Parameters:

context - the web context

trackableSession - the trackable session

Returns:

the new session store or null if this is not supported

renewSession

boolean renewSession(C context)

Renew the native session by copying all data to a new one.

Parameters:

context - the web context

Returns:

whether the session store has renewed the session