Package org.pac4j.oauth.profile.orcid
Class OrcidProfileDefinition
- java.lang.Object
-
- org.pac4j.core.profile.definition.ProfileDefinition<P>
-
- org.pac4j.core.profile.definition.CommonProfileDefinition<P>
-
- org.pac4j.oauth.profile.definition.OAuthProfileDefinition<P,com.github.scribejava.core.model.OAuth2AccessToken,C>
-
- org.pac4j.oauth.profile.definition.OAuth20ProfileDefinition<OrcidProfile,OAuth20Configuration>
-
- org.pac4j.oauth.profile.orcid.OrcidProfileDefinition
-
public class OrcidProfileDefinition extends OAuth20ProfileDefinition<OrcidProfile,OAuth20Configuration>
This class is the Orcid profile definition.- Since:
- 1.6.0
- Author:
- Jens Tinglev
-
-
Field Summary
Fields Modifier and Type Field Description static StringCLAIMEDstatic StringCREATION_METHODstatic StringFAMILY_NAMEstatic StringFIRST_NAMEstatic StringORCIDstatic StringURI-
Fields inherited from class org.pac4j.core.profile.definition.CommonProfileDefinition
DISPLAY_NAME, EMAIL, GENDER, LOCALE, LOCATION, PICTURE_URL, PROFILE_URL
-
Fields inherited from class org.pac4j.core.profile.definition.ProfileDefinition
logger, newProfile
-
-
Constructor Summary
Constructors Constructor Description OrcidProfileDefinition()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description OrcidProfileextractUserProfile(String body)Extract the user profile from the response (JSON, XML...) of the profile url.StringgetProfileUrl(com.github.scribejava.core.model.OAuth2AccessToken accessToken, OAuth20Configuration configuration)Retrieve the url of the profile of the authenticated user for the provider.-
Methods inherited from class org.pac4j.oauth.profile.definition.OAuthProfileDefinition
getProfileVerb, raiseProfileExtractionError, raiseProfileExtractionJsonError, raiseProfileExtractionJsonError
-
Methods inherited from class org.pac4j.core.profile.definition.CommonProfileDefinition
configurePrimaryAttributes
-
Methods inherited from class org.pac4j.core.profile.definition.ProfileDefinition
convertAndAdd, convertAndAdd, getConverters, getPrimaryAttributes, getProfileId, getSecondaryAttributes, newProfile, primary, secondary, setProfileFactory, setProfileId
-
-
-
-
Field Detail
-
ORCID
public static final String ORCID
- See Also:
- Constant Field Values
-
FIRST_NAME
public static final String FIRST_NAME
- See Also:
- Constant Field Values
-
FAMILY_NAME
public static final String FAMILY_NAME
- See Also:
- Constant Field Values
-
URI
public static final String URI
- See Also:
- Constant Field Values
-
CREATION_METHOD
public static final String CREATION_METHOD
- See Also:
- Constant Field Values
-
CLAIMED
public static final String CLAIMED
- See Also:
- Constant Field Values
-
-
Method Detail
-
getProfileUrl
public String getProfileUrl(com.github.scribejava.core.model.OAuth2AccessToken accessToken, OAuth20Configuration configuration)
Description copied from class:OAuthProfileDefinitionRetrieve the url of the profile of the authenticated user for the provider.- Specified by:
getProfileUrlin classOAuthProfileDefinition<OrcidProfile,com.github.scribejava.core.model.OAuth2AccessToken,OAuth20Configuration>- Parameters:
accessToken- only used when constructing dynamic urls from data in the tokenconfiguration- the current configuration- Returns:
- the url of the user profile given by the provider
-
extractUserProfile
public OrcidProfile extractUserProfile(String body)
Description copied from class:OAuthProfileDefinitionExtract the user profile from the response (JSON, XML...) of the profile url.- Specified by:
extractUserProfilein classOAuthProfileDefinition<OrcidProfile,com.github.scribejava.core.model.OAuth2AccessToken,OAuth20Configuration>- Parameters:
body- the response body- Returns:
- the returned profile
-
-