org.jooby.pac4j

Class AuthSessionStore<U extends org.pac4j.core.profile.CommonProfile>

java.lang.Object

org.jooby.pac4j.AuthSessionStore<U>

Type Parameters:

U - User profile to work with.

All Implemented Interfaces:

AuthStore<U>

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

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

Since:

0.6.0

Author:

edgar

Field Summary

Fields

Modifier and Type	Field and Description
static String	USER_PROFILE

Constructor Summary

Constructors

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

Method Summary

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

Methods inherited from class java.lang.Object

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

Field Detail

USER_PROFILE

public static final String USER_PROFILE

See Also:

Constant Field Values

Constructor Detail

AuthSessionStore

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

Method Detail

get

public Optional<U> get(String id)
                throws Exception

Description copied from interface: AuthStore

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

Specified by:

get in interface AuthStore<U extends org.pac4j.core.profile.CommonProfile>

Parameters:

id - ID of the profile to restore.

Returns:

An CommonProfile.

Throws:

Exception - If restore fails.

set

public void set(U profile)
         throws Exception

Description copied from interface: AuthStore

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

Specified by:

set in interface AuthStore<U extends org.pac4j.core.profile.CommonProfile>

Parameters:

profile - Profile to store.

Throws:

Exception - If store fails.

unset

public Optional<U> unset(String id)
                  throws Exception

Description copied from interface: AuthStore

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

Specified by:

unset in interface AuthStore<U extends org.pac4j.core.profile.CommonProfile>

Parameters:

id - ID of the profile to remove.

Throws:

Exception - If store fails.