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,OAuth20Configuration>

org.pac4j.oauth.profile.definition.OAuth20ProfileDefinition<OrcidProfile>

org.pac4j.oauth.profile.orcid.OrcidProfileDefinition

public class OrcidProfileDefinition
extends OAuth20ProfileDefinition<OrcidProfile>

This class is the Orcid profile definition.

Since:

1.6.0

Author:

Jens Tinglev

Field Summary

Fields

Modifier and Type	Field and Description
static String	CLAIMED
static String	CREATION_METHOD
static String	FAMILY_NAME
static String	FIRST_NAME
static String	ORCID
static String	URI

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 and Description
OrcidProfileDefinition()

Method Summary

Modifier and Type	Method and Description
OrcidProfile	extractUserProfile(String body) Extract the user profile from the response (JSON, XML...) of the profile url.
String	getProfileUrl(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

Methods inherited from class org.pac4j.core.profile.definition.ProfileDefinition

convertAndAdd, convertAndAdd, convertAndAdd, convertAndAdd, getConverters, getPrimaryAttributes, getSecondaryAttributes, newProfile, primary, secondary, setProfileFactory

Methods inherited from class java.lang.Object

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

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

Constructor Detail

OrcidProfileDefinition

public OrcidProfileDefinition()

Method Detail

getProfileUrl

public String getProfileUrl(com.github.scribejava.core.model.OAuth2AccessToken accessToken,
                            OAuth20Configuration configuration)

Description copied from class: OAuthProfileDefinition

Retrieve the url of the profile of the authenticated user for the provider.

Specified by:

getProfileUrl in class OAuthProfileDefinition<OrcidProfile,com.github.scribejava.core.model.OAuth2AccessToken,OAuth20Configuration>

Parameters:

accessToken - only used when constructing dynamic urls from data in the token

configuration - the current configuration

Returns:

the url of the user profile given by the provider

extractUserProfile

public OrcidProfile extractUserProfile(String body)
                                throws HttpAction

Description copied from class: OAuthProfileDefinition

Extract the user profile from the response (JSON, XML...) of the profile url.

Specified by:

extractUserProfile in class OAuthProfileDefinition<OrcidProfile,com.github.scribejava.core.model.OAuth2AccessToken,OAuth20Configuration>

Parameters:

body - the response body

Returns:

the returned profile

Throws:

HttpAction - whether an extra HTTP action is required