Package org.pac4j.core.profile
Interface UserProfile
- All Superinterfaces:
Serializable
- All Known Implementing Classes:
AbstractJwtProfile
,AnonymousProfile
,BasicUserProfile
,CommonProfile
The contract that all user profiles must respect.
- Since:
- 4.0.0
- Author:
- Jerome Leleu
-
Method Summary
Modifier and TypeMethodDescriptionvoid
addAttribute
(String key, Object value) addAttribute.void
addAuthenticationAttribute
(String key, Object value) addAuthenticationAttribute.void
addRole.void
addRoles
(Collection<String> roles) addRoles.asPrincipal.boolean
containsAttribute
(String name) containsAttribute.getAttribute
(String name) getAttribute.getAttributes.getClientName.getId()
getId.getLinkedId.getRoles()
getRoles.getTypedId.getUsername.boolean
isExpired.boolean
isRemembered.void
removeAttribute
(String key) removeAttribute.void
removeAuthenticationAttribute.void
setClientName
(String clientName) setClientName.void
setId.void
setLinkedId
(String linkedId) setLinkedId.void
setRemembered
(boolean rme) setRemembered.
-
Method Details
-
getId
String getId()getId.
- Returns:
- a
String
object
-
setId
setId.
- Parameters:
id
- aString
object
-
getTypedId
String getTypedId()getTypedId.
- Returns:
- a
String
object
-
getUsername
String getUsername()getUsername.
- Returns:
- a
String
object
-
getAttribute
getAttribute.
-
getAttributes
getAttributes.
- Returns:
- a
Map
object
-
containsAttribute
containsAttribute.
- Parameters:
name
- aString
object- Returns:
- a boolean
-
addAttribute
addAttribute.
-
removeAttribute
removeAttribute.
- Parameters:
key
- aString
object
-
addAuthenticationAttribute
addAuthenticationAttribute.
-
removeAuthenticationAttribute
removeAuthenticationAttribute.
- Parameters:
key
- aString
object
-
addRole
addRole.
- Parameters:
role
- aString
object
-
addRoles
addRoles.
- Parameters:
roles
- aCollection
object
-
getRoles
getRoles.
- Returns:
- a
Set
object
-
isRemembered
boolean isRemembered()isRemembered.
- Returns:
- a boolean
-
setRemembered
void setRemembered(boolean rme) setRemembered.
- Parameters:
rme
- a boolean
-
getClientName
String getClientName()getClientName.
- Returns:
- a
String
object
-
setClientName
setClientName.
- Parameters:
clientName
- aString
object
-
getLinkedId
String getLinkedId()getLinkedId.
- Returns:
- a
String
object
-
setLinkedId
setLinkedId.
- Parameters:
linkedId
- aString
object
-
isExpired
boolean isExpired()isExpired.
- Returns:
- a boolean
-
asPrincipal
Principal asPrincipal()asPrincipal.
- Returns:
- a
Principal
object
-