Package org.pac4j.core.profile
Class BasicUserProfile
java.lang.Object
org.pac4j.core.profile.BasicUserProfile
- All Implemented Interfaces:
Externalizable
,Serializable
,UserProfile
- Direct Known Subclasses:
CommonProfile
This class is the user profile retrieved from a provider after successful authentication: it's an identifier (string) and attributes
(objects). Additional concepts are the "remember me" nature of the user profile, the associated roles, permissions, client name and
linked identifier.
- Since:
- 1.0.0
- Author:
- Jerome Leleu
- See Also:
-
Field Summary
Fields -
Constructor Summary
ConstructorsConstructorDescriptionBasicUserProfile
(boolean canAttributesBeMerged) Create a profile with possibility to merge attributes with the same name and collection-type values. -
Method Summary
Modifier and TypeMethodDescriptionvoid
addAttribute
(String key, Object value) Add an attribute.void
addAttributes
(Map<String, Object> attributes) Add attributes.void
addAuthenticationAttribute
(String key, Object value) Add an authentication-related attributevoid
addAuthenticationAttributes
(Map<String, Object> attributeMap) Add authentication attributes.void
addPermission
(String permission) Add a permission.void
addPermissions
(Collection<String> permissions) Add permissions.void
Add a role.void
addRoles
(Collection<String> roles) Add roles.void
Build a profile from user identifier and attributes.void
Build a profile from user identifier, attributes, and authentication attributes.boolean
containsAttribute
(String name) Check to see if profile contains attribute name.boolean
Check to see if profile contains attribute name.extractAttributeValues
(String name) Return the attribute values with name.getAttribute
(String name) Return the attribute with name.<T> T
getAttribute
(String name, Class<T> clazz) Return the attribute with name.Get all attributes as immutable map.Return the authentication attribute with name.<T> T
getAuthenticationAttribute
(String name, Class<T> clazz) Return authentication attribute with nameGet all authentication attributes as an immutable mapgetId()
Get the user identifier.Get the permissions of the user.getRoles()
Get the roles of the user.Get the user identifier with a prefix which is the profile type (full class name with package).boolean
boolean
Is the user remembered?void
void
removeAttribute
(String key) Remove an attribute by its key.void
Remove an authentication attribute by its keyvoid
Remove the specific data retrieved during the login process to only keep the user attributes, roles and permissions.void
setClientName
(String clientName) void
Set the identifier.void
setLinkedId
(String linkedId) void
setPermissions
(Set<String> permissions) void
setRemembered
(boolean rme) Define if this profile is remembered.void
toString()
void
-
Field Details
-
logger
protected final transient org.slf4j.Logger logger
-
-
Constructor Details
-
BasicUserProfile
public BasicUserProfile() -
BasicUserProfile
public BasicUserProfile(boolean canAttributesBeMerged) Create a profile with possibility to merge attributes with the same name and collection-type values.- Parameters:
canAttributesBeMerged
- if true - merge attributes with the same name and collection-type values, if false - overwrite them- Since:
- 3.1.0
-
-
Method Details
-
build
Build a profile from user identifier and attributes.- Parameters:
id
- user identifierattributes
- user attributes
-
build
public void build(Object id, Map<String, Object> attributes, Map<String, Object> authenticationAttributes) Build a profile from user identifier, attributes, and authentication attributes.- Parameters:
id
- user identifierattributes
- user attributesauthenticationAttributes
- authentication attributes
-
setId
Set the identifier.- Specified by:
setId
in interfaceUserProfile
- Parameters:
id
- user identifier
-
getId
Get the user identifier. This identifier is unique for this provider but not necessarily through all providers.- Specified by:
getId
in interfaceUserProfile
- Returns:
- the user identifier
-
getTypedId
Get the user identifier with a prefix which is the profile type (full class name with package). This identifier is unique through all providers.- Specified by:
getTypedId
in interfaceUserProfile
- Returns:
- the typed user identifier
-
getUsername
- Specified by:
getUsername
in interfaceUserProfile
-
addAttribute
Add an attribute. If existing attribute value is collection and the new value is collection - merge the collections- Specified by:
addAttribute
in interfaceUserProfile
- Parameters:
key
- key of the attributevalue
- value of the attribute
-
addAuthenticationAttribute
Add an authentication-related attribute- Specified by:
addAuthenticationAttribute
in interfaceUserProfile
- Parameters:
key
- the attribute keyvalue
- the attribute value
-
addAttributes
Add attributes.- Parameters:
attributes
- use attributes
-
addAuthenticationAttributes
Add authentication attributes.- Parameters:
attributeMap
- the authentication attributes
-
removeAttribute
Remove an attribute by its key.- Specified by:
removeAttribute
in interfaceUserProfile
- Parameters:
key
- the key
-
removeAuthenticationAttribute
Remove an authentication attribute by its key- Specified by:
removeAuthenticationAttribute
in interfaceUserProfile
- Parameters:
key
- the key
-
getAttributes
Get all attributes as immutable map.- Specified by:
getAttributes
in interfaceUserProfile
- Returns:
- the immutable attributes
-
getAuthenticationAttributes
Get all authentication attributes as an immutable map- Returns:
- the immutable authentication attributes
-
getAttribute
Return the attribute with name.- Specified by:
getAttribute
in interfaceUserProfile
- Parameters:
name
- attribute name- Returns:
- the attribute with name
-
extractAttributeValues
Return the attribute values with name.- Parameters:
name
- attribute name- Returns:
- the attribute values as List of strings.
-
getAuthenticationAttribute
Return the authentication attribute with name.- Parameters:
name
- authentication attribute name- Returns:
- the authentication attribute with name
-
containsAttribute
Check to see if profile contains attribute name.- Specified by:
containsAttribute
in interfaceUserProfile
- Parameters:
name
- the name- Returns:
- true/false
-
containsAuthenicationAttribute
Check to see if profile contains attribute name.- Parameters:
name
- the name- Returns:
- true/false
-
getAttribute
Return the attribute with name.- Type Parameters:
T
- the type of the attribute- Parameters:
name
- the attribute nameclazz
- the class of the attribute- Returns:
- the attribute by its name
- Since:
- 1.8
-
getAuthenticationAttribute
Return authentication attribute with name- Type Parameters:
T
- The type of the authentication attribute- Parameters:
name
- Name of authentication attributeclazz
- The class of the authentication attribute- Returns:
- the named attribute
-
addRole
Add a role.- Specified by:
addRole
in interfaceUserProfile
- Parameters:
role
- the role to add.
-
addRoles
Add roles.- Specified by:
addRoles
in interfaceUserProfile
- Parameters:
roles
- the roles to add.
-
getRoles
Get the roles of the user.- Specified by:
getRoles
in interfaceUserProfile
- Returns:
- the user roles.
-
setRoles
-
addPermission
Add a permission.- Specified by:
addPermission
in interfaceUserProfile
- Parameters:
permission
- the permission to add.
-
addPermissions
Add permissions.- Specified by:
addPermissions
in interfaceUserProfile
- Parameters:
permissions
- the permissions to add.
-
getPermissions
Get the permissions of the user.- Specified by:
getPermissions
in interfaceUserProfile
- Returns:
- the user permissions.
-
setPermissions
-
setRemembered
public void setRemembered(boolean rme) Define if this profile is remembered.- Specified by:
setRemembered
in interfaceUserProfile
- Parameters:
rme
- whether the user is remembered.
-
isRemembered
public boolean isRemembered()Is the user remembered?- Specified by:
isRemembered
in interfaceUserProfile
- Returns:
- whether the user is remembered.
-
toString
-
writeExternal
- Specified by:
writeExternal
in interfaceExternalizable
- Throws:
IOException
-
readExternal
- Specified by:
readExternal
in interfaceExternalizable
- Throws:
IOException
ClassNotFoundException
-
removeLoginData
public void removeLoginData()Remove the specific data retrieved during the login process to only keep the user attributes, roles and permissions. -
getClientName
- Specified by:
getClientName
in interfaceUserProfile
-
setClientName
- Specified by:
setClientName
in interfaceUserProfile
-
getLinkedId
- Specified by:
getLinkedId
in interfaceUserProfile
-
setLinkedId
- Specified by:
setLinkedId
in interfaceUserProfile
-
isExpired
public boolean isExpired()- Specified by:
isExpired
in interfaceUserProfile
-
asPrincipal
- Specified by:
asPrincipal
in interfaceUserProfile
-