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, i.e. the one of the current authenticated user.

It may be partially re-implemented for specific needs / frameworks.

Since:

1.8.0

Author:

Jerome Leleu

Field Summary

Fields

Modifier and Type	Field and Description
protected WebContext	context

Constructor Summary

Constructors

Constructor and Description
ProfileManager(WebContext context)

Method Summary

Modifier and Type	Method and Description
U	get(boolean readFromSession) Retrieve the current user profile (from request first and then from the session if not found and requested).
boolean	isAuthenticated() Tests if the current is authenticated (meaning a user profile exists).
void	logout() Perform a logout by removing the current user profile from the session as well.
void	remove(boolean removeFromSession) Remove the current user profile.
void	save(boolean saveInSession, U profile) Save the given user profile as the current one.

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

Constructor Detail

ProfileManager

public ProfileManager(WebContext context)

Method Detail

get

public U get(boolean readFromSession)

Retrieve the current user profile (from request first and then from the session if not found and requested).

Parameters:

readFromSession - if the user profile must be read from session

Returns:

the user profile

remove

public void remove(boolean removeFromSession)

Remove the current user profile.

Parameters:

removeFromSession - if the user profile must be removed from session

save

public void save(boolean saveInSession,
                 U profile)

Save the given user profile as the current one.

Parameters:

saveInSession - if the user profile must be saved in session

profile - a given user profile

logout

public void logout()

Perform a logout by removing the current user profile from the session as well.

isAuthenticated

public boolean isAuthenticated()

Tests if the current is authenticated (meaning a user profile exists).

Returns:

whether the current user is authenticated