org.pac4j.core.context.session

Class J2ESessionStore

java.lang.Object

org.pac4j.core.context.session.J2ESessionStore

All Implemented Interfaces:

SessionStore<J2EContext>

public class J2ESessionStore
extends Object
implements SessionStore<J2EContext>

Store data in the J2E web session.

Since:

1.8.1

Author:

Jerome Leleu

Field Summary

Fields

Modifier and Type	Field and Description
protected org.slf4j.Logger	logger

Constructor Summary

Constructors

Constructor and Description
J2ESessionStore()

Method Summary

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

Methods inherited from class java.lang.Object

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

Field Detail

logger

protected final org.slf4j.Logger logger

Constructor Detail

J2ESessionStore

public J2ESessionStore()

Method Detail

getHttpSession

protected javax.servlet.http.HttpSession getHttpSession(J2EContext context)

getOrCreateSessionId

public String getOrCreateSessionId(J2EContext context)

Description copied from interface: SessionStore

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

Specified by:

getOrCreateSessionId in interface SessionStore<J2EContext>

Parameters:

context - the web context

Returns:

the session identifier

get

public Object get(J2EContext context,
                  String key)

Description copied from interface: SessionStore

Get the object from its key in store.

Specified by:

get in interface SessionStore<J2EContext>

Parameters:

context - the web context

key - the key of the object

Returns:

the object in store

set

public void set(J2EContext context,
                String key,
                Object value)

Description copied from interface: SessionStore

Save an object in the store by its key.

Specified by:

set in interface SessionStore<J2EContext>

Parameters:

context - the web context

key - the key of the object

value - the value to save in store

destroySession

public boolean destroySession(J2EContext context)

Description copied from interface: SessionStore

Destroy the web session.

Specified by:

destroySession in interface SessionStore<J2EContext>

Parameters:

context - the web context

Returns:

whether the session has been destroyed

getTrackableSession

public Object getTrackableSession(J2EContext context)

Description copied from interface: SessionStore

Get the native session as a trackable object.

Specified by:

getTrackableSession in interface SessionStore<J2EContext>

Parameters:

context - the web context

Returns:

the trackable object or null if this is not supported

buildFromTrackableSession

public SessionStore<J2EContext> buildFromTrackableSession(J2EContext context,
                                                          Object trackableSession)

Description copied from interface: SessionStore

Build a new session store from a trackable session.

Specified by:

buildFromTrackableSession in interface SessionStore<J2EContext>

Parameters:

context - the web context

trackableSession - the trackable session

Returns:

the new session store or null if this is not supported

renewSession

public boolean renewSession(J2EContext context)

Description copied from interface: SessionStore

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

Specified by:

renewSession in interface SessionStore<J2EContext>

Parameters:

context - the web context

Returns:

whether the session store has renewed the session