org.pac4j.play

Class StorageHelper

java.lang.Object

org.pac4j.play.StorageHelper

public final class StorageHelper
extends Object

This class is an helper to store/retrieve objects (from cache).

Since:

1.1.0

Author:

Jerome Leleu

Constructor Summary

Constructors

Constructor and Description
StorageHelper()

Method Summary

Modifier and Type	Method and Description
static String	generateSessionId() Generate a session identifier.
static Object	get(String key) Get an object from storage.
static Object	get(String sessionId, String key) Get an object from storage.
static String	getOrCreationSessionId(play.mvc.Http.Session session) Get a session identifier and generates it if no session exists.
static org.pac4j.core.profile.CommonProfile	getProfile(String sessionId) Get the profile from storage.
static String	getRequestedUrl(String sessionId, String clientName) Get a requested url from storage.
static void	remove(String key) Remove an object from storage.
static void	remove(String sessionId, String key) Remove an object in storage.
static void	removeProfile(String sessionId) Remove a user profile from storage.
static void	save(String key, Object value, int timeout) Save an object in storage.
static void	save(String sessionId, String key, Object value) Save an object in storage.
static void	saveProfile(String sessionId, org.pac4j.core.profile.CommonProfile profile) Save a user profile in storage.
static void	saveRequestedUrl(String sessionId, String clientName, String requestedUrl) Save a requested url to storage.

Methods inherited from class java.lang.Object

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

Constructor Detail

StorageHelper

public StorageHelper()

Method Detail

getOrCreationSessionId

public static String getOrCreationSessionId(play.mvc.Http.Session session)

Get a session identifier and generates it if no session exists.

Parameters:

session -

Returns:

the session identifier

generateSessionId

public static String generateSessionId()

Generate a session identifier.

Returns:

a session identifier

getProfile

public static org.pac4j.core.profile.CommonProfile getProfile(String sessionId)

Get the profile from storage.

Parameters:

sessionId -

Returns:

the user profile

saveProfile

public static void saveProfile(String sessionId,
                               org.pac4j.core.profile.CommonProfile profile)

Save a user profile in storage.

Parameters:

sessionId -

profile -

removeProfile

public static void removeProfile(String sessionId)

Remove a user profile from storage.

Parameters:

sessionId -

getRequestedUrl

public static String getRequestedUrl(String sessionId,
                                     String clientName)

Get a requested url from storage.

Parameters:

sessionId -

clientName -

Returns:

the requested url

saveRequestedUrl

public static void saveRequestedUrl(String sessionId,
                                    String clientName,
                                    String requestedUrl)

Save a requested url to storage.

Parameters:

sessionId -

clientName -

requestedUrl -

get

public static Object get(String sessionId,
                         String key)

Get an object from storage.

Parameters:

sessionId -

key -

Returns:

the object

save

public static void save(String sessionId,
                        String key,
                        Object value)

Save an object in storage.

Parameters:

sessionId -

key -

value -

remove

public static void remove(String sessionId,
                          String key)

Remove an object in storage.

Parameters:

sessionId -

key -

get

public static Object get(String key)

Get an object from storage.

Parameters:

key -

Returns:

the object

save

public static void save(String key,
                        Object value,
                        int timeout)

Save an object in storage.

Parameters:

key -

value -

timeout -

remove

public static void remove(String key)

Remove an object from storage.

Parameters:

key -