org.jooby.pac4j

Class AuthSessionStore

java.lang.Object

org.jooby.pac4j.AuthSessionStore

All Implemented Interfaces:

AuthStore<org.pac4j.core.profile.UserProfile>

public class AuthSessionStore
extends Object
implements AuthStore<org.pac4j.core.profile.UserProfile>

An AuthStore on top of the Session. This is the default AuthStore.

Since:

0.6.0

Author:

edgar

Constructor Summary

Constructors

Constructor and Description
AuthSessionStore(javax.inject.Provider<Session> session)

Method Summary

Modifier and Type	Method and Description
Optional<org.pac4j.core.profile.UserProfile>	get(String id) Call it after a successful authentication in order to restore an UserProfile.
void	set(org.pac4j.core.profile.UserProfile profile) Call it after a successful authentication in order to store an UserProfile.
Optional<org.pac4j.core.profile.UserProfile>	unset(String id) Call it on logout in order to remove an UserProfile from the store.

Methods inherited from class java.lang.Object

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

Constructor Detail

AuthSessionStore

@Inject
public AuthSessionStore(javax.inject.Provider<Session> session)

Method Detail

get

public Optional<org.pac4j.core.profile.UserProfile> get(String id)
                                                 throws Exception

Description copied from interface: AuthStore

Call it after a successful authentication in order to restore an UserProfile. If profile is present, no authentication is required because user was already authenticated.

Specified by:

get in interface AuthStore<org.pac4j.core.profile.UserProfile>

Parameters:

id - ID of the profile to restore.

Returns:

An UserProfile.

Throws:

Exception - If restore fails.

set

public void set(org.pac4j.core.profile.UserProfile profile)

Description copied from interface: AuthStore

Call it after a successful authentication in order to store an UserProfile. The user was successfully authenticated and we want to save it somewhere.

Specified by:

set in interface AuthStore<org.pac4j.core.profile.UserProfile>

Parameters:

profile - Profile to store.

unset

public Optional<org.pac4j.core.profile.UserProfile> unset(String id)
                                                   throws Exception

Description copied from interface: AuthStore

Call it on logout in order to remove an UserProfile from the store.

Specified by:

unset in interface AuthStore<org.pac4j.core.profile.UserProfile>

Parameters:

id - ID of the profile to remove.

Throws:

Exception - If store fails.