Package org.pac4j.core.profile

Class ProfileManager<U extends UserProfile>

java.lang.Object

org.pac4j.core.profile.ProfileManager<U>

public class ProfileManager<U extends UserProfile>
extends Object

This class is a generic way to manage the current user profile(s), i.e. the one(s) of the current authenticated user.

Since:

1.8.0

Author:

Jerome Leleu

Field Summary

Fields

Modifier and Type	Field	Description
protected Config	config
protected WebContext	context
protected SessionStore	sessionStore

Constructor Summary

Constructors

Constructor	Description
ProfileManager(WebContext context)
ProfileManager(WebContext context, SessionStore sessionStore)

Method Summary

Modifier and Type	Method	Description
Optional<U>	get(boolean readFromSession)	Retrieve the first user profile if it exists, ignoring any AnonymousProfile if possible.
List<U>	getAll(boolean readFromSession)	Retrieve all user profiles.
Config	getConfig()
boolean	isAuthenticated()	Tests if the current user is authenticated (meaning a user profile exists which is not an AnonymousProfile).
void	logout()	Perform a logout by removing the current user profile(s).
void	remove(boolean removeFromSession)	Remove the current user profile(s).
protected void	removeOrRenewExpiredProfiles(LinkedHashMap<String,U> profiles)
protected LinkedHashMap<String,U>	retrieveAll(boolean readFromSession)	Retrieve the map of profiles from the session or the request.
protected String	retrieveClientName(U profile)
void	save(boolean saveInSession, U profile, boolean multiProfile)	Save the given user profile (replace the current one if multi profiles are not supported, add it otherwise).
void	setConfig(Config config)

Methods inherited from class java.lang.Object

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

Field Detail

context

protected final WebContext context

sessionStore

protected final SessionStore sessionStore

config

protected Config config

Constructor Detail

ProfileManager

public ProfileManager(WebContext context)

ProfileManager

public ProfileManager(WebContext context,
                      SessionStore sessionStore)

Method Detail

get

public Optional<U> get(boolean readFromSession)

Retrieve the first user profile if it exists, ignoring any AnonymousProfile if possible.

Parameters:

readFromSession - if the user profile must be read from session

Returns:

the user profile

getAll

public List<U> getAll(boolean readFromSession)

Retrieve all user profiles.

Parameters:

readFromSession - if the user profiles must be read from session

Returns:

the user profiles

retrieveAll

protected LinkedHashMap<String,U> retrieveAll(boolean readFromSession)

Retrieve the map of profiles from the session or the request.

Parameters:

readFromSession - if the user profiles must be read from session

Returns:

the map of profiles

removeOrRenewExpiredProfiles

protected void removeOrRenewExpiredProfiles(LinkedHashMap<String,U> profiles)

remove

public void remove(boolean removeFromSession)

Remove the current user profile(s).

Parameters:

removeFromSession - if the user profile(s) must be removed from session

save

public void save(boolean saveInSession,
                 U profile,
                 boolean multiProfile)

Save the given user profile (replace the current one if multi profiles are not supported, add it otherwise).

Parameters:

saveInSession - if the user profile must be saved in session

profile - a given user profile

multiProfile - whether multiple profiles are supported

retrieveClientName

protected String retrieveClientName(U profile)

logout

public void logout()

Perform a logout by removing the current user profile(s).

isAuthenticated

public boolean isAuthenticated()

Tests if the current user is authenticated (meaning a user profile exists which is not an AnonymousProfile).

Returns:

whether the current user is authenticated

getConfig

public Config getConfig()

setConfig

public void setConfig(Config config)