org.jooby.pac4j

Interface AuthStore<U extends org.pac4j.core.profile.UserProfile>

Type Parameters:

U - User profile to work with.

All Known Implementing Classes:

AuthSessionStore

public interface AuthStore<U extends org.pac4j.core.profile.UserProfile>

Contract for saving and restoring UserProfile.

Author:

edgar

Method Summary

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

Method Detail

get

Optional<U> get(String id)
         throws Exception

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.

Parameters:

id - ID of the profile to restore.

Returns:

An UserProfile.

Throws:

Exception - If restore fails.

set

void set(U profile)
  throws Exception

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

Parameters:

profile - Profile to store.

Throws:

Exception - If store fails.

unset

Optional<U> unset(String id)
           throws Exception

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

Parameters:

id - ID of the profile to remove.

Throws:

Exception - If store fails.