Package org.pac4j.core.profile

Class CommonProfile

java.lang.Object

org.pac4j.core.profile.BasicUserProfile

org.pac4j.core.profile.CommonProfile

All Implemented Interfaces:

Externalizable, Serializable, UserProfile

Direct Known Subclasses:

AbstractJwtProfile, AnonymousProfile

public class CommonProfile
extends BasicUserProfile

This class is the base implementation with the default attribute getters which can be retrieved for most profiles.

Since:

1.3.0

Author:

Jerome Leleu

See Also:

• Serialized Form

Field Summary

Fields inherited from class org.pac4j.core.profile.BasicUserProfile

logger

Constructor Summary

Constructors

Constructor	Description
CommonProfile()
CommonProfile(boolean canMergeAttributes)	Create a profile with possibility to merge attributes with the same name and collection-type values

Method Summary

Modifier and Type	Method	Description
protected Date	getAttributeAsDate(String name)
protected String	getAttributeAsString(String name)
protected <T> T	getAttributeAsType(String name, Class<T> clazz, T defaultValue)
String	getDisplayName()	Return the displayed name of the user.
String	getEmail()	Return the email of the user.
String	getFamilyName()	Return the family name of the user.
String	getFirstName()	Return the first name of the user.
Gender	getGender()	Return the gender of the user.
Locale	getLocale()	Return the locale of the user.
String	getLocation()	Return the location of the user.
URI	getPictureUrl()	Return the url of the picture of the user.
URI	getProfileUrl()	Return the url of the profile of the user.
String	getUsername()	Return the username of the user.
boolean	isExpired()

Methods inherited from class org.pac4j.core.profile.BasicUserProfile

addAttribute, addAttributes, addAuthenticationAttribute, addAuthenticationAttributes, addPermission, addPermissions, addRole, addRoles, asPrincipal, build, build, containsAttribute, containsAuthenicationAttribute, extractAttributeValues, getAttribute, getAttribute, getAttributes, getAuthenticationAttribute, getAuthenticationAttribute, getAuthenticationAttributes, getClientName, getId, getLinkedId, getPermissions, getRoles, getTypedId, isRemembered, readExternal, removeAttribute, removeAuthenticationAttribute, removeLoginData, setClientName, setId, setLinkedId, setPermissions, setRemembered, setRoles, toString, writeExternal

Methods inherited from class java.lang.Object

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

Constructor Details

CommonProfile

public CommonProfile()

CommonProfile

public CommonProfile(boolean canMergeAttributes)

Create a profile with possibility to merge attributes with the same name and collection-type values

Parameters:

canMergeAttributes - if true - merge attributes with the same name and collection-type values, if false - overwrite them

Since:

3.1.0

Method Details

getEmail

public String getEmail()

Return the email of the user.

Returns:

the email of the user

getFirstName

public String getFirstName()

Return the first name of the user.

Returns:

the first name of the user

getFamilyName

public String getFamilyName()

Return the family name of the user.

Returns:

the family name of the user

getDisplayName

public String getDisplayName()

Return the displayed name of the user. It can be the username or the first and last names (separated by a space).

Returns:

the displayed name of the user

getUsername

public String getUsername()

Return the username of the user. It can be a login or a specific username.

Specified by:

getUsername in interface UserProfile

Overrides:

getUsername in class BasicUserProfile

Returns:

the username of the user

getGender

public Gender getGender()

Return the gender of the user.

Returns:

the gender of the user

getLocale

public Locale getLocale()

Return the locale of the user.

Returns:

the locale of the user

getPictureUrl

public URI getPictureUrl()

Return the url of the picture of the user.

Returns:

the url of the picture of the user.

getProfileUrl

public URI getProfileUrl()

Return the url of the profile of the user.

Returns:

the url of the profile of the user.

getLocation

public String getLocation()

Return the location of the user.

Returns:

the location of the user

isExpired

public boolean isExpired()

Specified by:

isExpired in interface UserProfile

Overrides:

isExpired in class BasicUserProfile

getAttributeAsString

protected String getAttributeAsString(String name)

getAttributeAsType

protected <T> T getAttributeAsType(String name,
 Class<T> clazz,
 T defaultValue)

getAttributeAsDate

protected Date getAttributeAsDate(String name)