org.pac4j.core.profile

Class UserProfile

java.lang.Object

org.pac4j.core.profile.UserProfile

All Implemented Interfaces:

Externalizable, Serializable

Direct Known Subclasses:

CommonProfile

public abstract class UserProfile
extends Object
implements Serializable, Externalizable

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:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected org.slf4j.Logger	logger
static String	SEPARATOR

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	UserProfile()
protected	UserProfile(boolean canAttributesBeMerged) Create a profile with possibility to merge attributes with the same name and collection-type values.

Method Summary

Modifier and Type	Method and Description
void	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 attribute
void	addAuthenticationAttributes(Map<String,Object> attributeMap) Add authentication attributes.
void	addPermission(String permission) Add a permission.
void	addPermissions(Collection<String> permissions) Add permissions.
void	addRole(String role) Add a role.
void	addRoles(Collection<String> roles) Add roles.
void	addRoles(Set<String> roles) Add roles.
void	build(Object id, Map<String,Object> attributes) Build a profile from user identifier and attributes.
void	build(Object id, Map<String,Object> attributes, Map<String,Object> authenticationAttributes) Build a profile from user identifier, attributes, and authentication attributes.
void	clearSensitiveData()
boolean	containsAttribute(String name) Check to see if profile contains attribute name.
boolean	containsAuthenicationAttribute(String name) Check to see if profile contains attribute name.
Object	getAttribute(String name) Return the attribute with name.
<T> T	getAttribute(String name, Class<T> clazz) Return the attribute with name.
Map<String,Object>	getAttributes() Get all attributes as immutable map.
Object	getAuthenticationAttribute(String name) Return the authentication attribute with name.
<T> T	getAuthenticationAttribute(String name, Class<T> clazz) Return authentication attribute with name
Map<String,Object>	getAuthenticationAttributes() Get all authentication attributes as an immutable map
String	getClientName()
String	getId() Get the user identifier.
String	getLinkedId()
Set<String>	getPermissions() Get the permissions of the user.
Set<String>	getRoles() Get the roles of the user.
String	getTypedId() Get the user identifier with a prefix which is the profile type (full class name with package).
boolean	isRemembered() Is the user remembered?
void	readExternal(ObjectInput in)
void	removeAttribute(String key) Remove an attribute by its key.
void	removeAuthenticationAttribute(String key) Remove an authentication attribute by its key
void	setClientName(String clientName)
void	setId(String id) Set the identifier.
void	setLinkedId(String linkedId)
void	setPermissions(Set<String> permissions)
void	setRemembered(boolean rme) Define if this profile is remembered.
void	setRoles(Set<String> roles)
String	toString()
void	writeExternal(ObjectOutput out)

Methods inherited from class java.lang.Object

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

Field Detail

logger

protected final transient org.slf4j.Logger logger

SEPARATOR

public static final transient String SEPARATOR

See Also:

Constant Field Values

Constructor Detail

UserProfile

protected UserProfile()

UserProfile

protected UserProfile(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 Detail

build

public void build(Object id,
                  Map<String,Object> attributes)

Build a profile from user identifier and attributes.

Parameters:

id - user identifier

attributes - 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 identifier

attributes - user attributes

authenticationAttributes - authentication attributes

addAttribute

public void addAttribute(String key,
                         Object value)

Add an attribute. If existing attribute value is collection and the new value is collection - merge the collections

Parameters:

key - key of the attribute

value - value of the attribute

addAuthenticationAttribute

public void addAuthenticationAttribute(String key,
                                       Object value)

Add an authentication-related attribute

Parameters:

key - the attribute key

value - the attribute value

addAttributes

public void addAttributes(Map<String,Object> attributes)

Add attributes.

Parameters:

attributes - use attributes

addAuthenticationAttributes

public void addAuthenticationAttributes(Map<String,Object> attributeMap)

Add authentication attributes.

Parameters:

attributeMap - the authentication attributes

removeAttribute

public void removeAttribute(String key)

Remove an attribute by its key.

Parameters:

key - the key

removeAuthenticationAttribute

public void removeAuthenticationAttribute(String key)

Remove an authentication attribute by its key

Parameters:

key - the key

setId

public void setId(String id)

Set the identifier.

Parameters:

id - user identifier

getId

public String getId()

Get the user identifier. This identifier is unique for this provider but not necessarily through all providers.

Returns:

the user identifier

getTypedId

public String 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.

Returns:

the typed user identifier

getAttributes

public Map<String,Object> getAttributes()

Get all attributes as immutable map.

Returns:

the immutable attributes

getAuthenticationAttributes

public Map<String,Object> getAuthenticationAttributes()

Get all authentication attributes as an immutable map

Returns:

the immutable authentication attributes

getAttribute

public Object getAttribute(String name)

Return the attribute with name.

Parameters:

name - attribute name

Returns:

the attribute with name

getAuthenticationAttribute

public Object getAuthenticationAttribute(String name)

Return the authentication attribute with name.

Parameters:

name - authentication attribute name

Returns:

the authentication attribute with name

containsAttribute

public boolean containsAttribute(String name)

Check to see if profile contains attribute name.

Parameters:

name - the name

Returns:

true/false

containsAuthenicationAttribute

public boolean containsAuthenicationAttribute(String name)

Check to see if profile contains attribute name.

Parameters:

name - the name

Returns:

true/false

getAttribute

public <T> T getAttribute(String name,
                          Class<T> clazz)

Return the attribute with name.

Type Parameters:

T - the type of the attribute

Parameters:

name - the attribute name

clazz - the class of the attribute

Returns:

the attribute by its name

Since:

1.8

getAuthenticationAttribute

public <T> T getAuthenticationAttribute(String name,
                                        Class<T> clazz)

Return authentication attribute with name

Type Parameters:

T - The type of the authentication attribute

Parameters:

name - Name of authentication attribute

clazz - The class of the authentication attribute

Returns:

the named attribute

addRole

public void addRole(String role)

Add a role.

Parameters:

role - the role to add.

addRoles

public void addRoles(Collection<String> roles)

Add roles.

Parameters:

roles - the roles to add.

addRoles

public void addRoles(Set<String> roles)

Add roles.

Parameters:

roles - the roles to add.

addPermission

public void addPermission(String permission)

Add a permission.

Parameters:

permission - the permission to add.

addPermissions

public void addPermissions(Collection<String> permissions)

Add permissions.

Parameters:

permissions - the permissions to add.

setRemembered

public void setRemembered(boolean rme)

Define if this profile is remembered.

Parameters:

rme - whether the user is remembered.

getRoles

public Set<String> getRoles()

Get the roles of the user.

Returns:

the user roles.

setRoles

public void setRoles(Set<String> roles)

getPermissions

public Set<String> getPermissions()

Get the permissions of the user.

Returns:

the user permissions.

setPermissions

public void setPermissions(Set<String> permissions)

isRemembered

public boolean isRemembered()

Is the user remembered?

Returns:

whether the user is remembered.

toString

public String toString()

Overrides:

toString in class Object

writeExternal

public void writeExternal(ObjectOutput out)
                   throws IOException

Specified by:

writeExternal in interface Externalizable

Throws:

IOException

readExternal

public void readExternal(ObjectInput in)
                  throws IOException,
                         ClassNotFoundException

Specified by:

readExternal in interface Externalizable

Throws:

IOException

ClassNotFoundException

clearSensitiveData

public void clearSensitiveData()

getClientName

public String getClientName()

setClientName

public void setClientName(String clientName)

getLinkedId

public String getLinkedId()

setLinkedId

public void setLinkedId(String linkedId)