org.pac4j.oauth.profile.orcid

Class OrcidProfile

java.lang.Object

org.pac4j.core.profile.UserProfile

org.pac4j.core.profile.CommonProfile

org.pac4j.oauth.profile.OAuth20Profile

org.pac4j.oauth.profile.orcid.OrcidProfile

All Implemented Interfaces:

Externalizable, Serializable

public class OrcidProfile
extends OAuth20Profile

This class is the user profile for ORCiD with appropriate getters.

It is returned by the OrcidClient.

Since:

1.6.0

Author:

Jens Tinglev

See Also:

Serialized Form

Field Summary

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

logger, SEPARATOR

Constructor Summary

Constructors

Constructor and Description
OrcidProfile()

Method Summary

Modifier and Type	Method and Description
AttributesDefinition	getAttributesDefinition() Return the attributes definition for this user profile.
boolean	getClaimed()
String	getCreationMethod()
String	getFamilyName() Return the family name of the user.
String	getFirstName() Return the first name of the user.
Locale	getLocale() Return the locale of the user.
String	getOrcid()
String	getProfileUrl() Return the url of the profile of the user.

Methods inherited from class org.pac4j.oauth.profile.OAuth20Profile

clearSensitiveData, getAccessToken, setAccessToken

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

getDisplayName, getEmail, getGender, getLocation, getPictureUrl, getUsername

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

addAttribute, addAttributes, addPermission, addPermissions, addPermissions, addRole, addRoles, addRoles, build, getAttribute, getAttribute, getAttributes, getClientName, getId, getOldTypedId, getPermissions, getRoles, getTypedId, isRemembered, readExternal, removeAttribute, setClientName, setId, setRemembered, toString, writeExternal

Methods inherited from class java.lang.Object

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

Constructor Detail

OrcidProfile

public OrcidProfile()

Method Detail

getAttributesDefinition

public AttributesDefinition getAttributesDefinition()

Description copied from class: UserProfile

Return the attributes definition for this user profile. null for a (generic) user profile.

Overrides:

getAttributesDefinition in class UserProfile

Returns:

the attributes definition

getOrcid

public String getOrcid()

getClaimed

public boolean getClaimed()

getCreationMethod

public String getCreationMethod()

getFirstName

public String getFirstName()

Description copied from class: CommonProfile

Return the first name of the user.

Overrides:

getFirstName in class CommonProfile

Returns:

the first name of the user

getFamilyName

public String getFamilyName()

Description copied from class: CommonProfile

Return the family name of the user.

Overrides:

getFamilyName in class CommonProfile

Returns:

the family name of the user

getLocale

public Locale getLocale()

Description copied from class: CommonProfile

Return the locale of the user.

Overrides:

getLocale in class CommonProfile

Returns:

the locale of the user

getProfileUrl

public String getProfileUrl()

Description copied from class: CommonProfile

Return the url of the profile of the user.

Overrides:

getProfileUrl in class CommonProfile

Returns:

the url of the profile of the user.