Package org.pac4j.oauth.profile.dropbox
Class DropBoxProfileDefinition
java.lang.Object
org.pac4j.core.profile.definition.ProfileDefinition
org.pac4j.core.profile.definition.CommonProfileDefinition
org.pac4j.oauth.profile.definition.OAuthProfileDefinition
org.pac4j.oauth.profile.dropbox.DropBoxProfileDefinition
This class is the DropBox profile definition.
- Since:
- 1.2.0
- Author:
- Jerome Leleu
-
Field Summary
Modifier and TypeFieldDescriptionstatic final String
ConstantCOUNTRY="country"
static final String
ConstantEMAIL_VERIFIED="email_verified"
static final String
ConstantREFERRAL_LINK="referral_link"
Fields inherited from class org.pac4j.core.profile.definition.CommonProfileDefinition
DISPLAY_NAME, EMAIL, FAMILY_NAME, FIRST_NAME, GENDER, LOCALE, LOCATION, PICTURE_URL, PROFILE_URL
Fields inherited from class org.pac4j.core.profile.definition.ProfileDefinition
logger
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionextractUserProfile
(String body) Extract the user profile from the response (JSON, XML...) of the profile url.getProfileUrl
(com.github.scribejava.core.model.Token token, OAuthConfiguration configuration) Retrieve the url of the profile of the authenticated user for the provider.com.github.scribejava.core.model.Verb
Get HTTP Method to request profile.Methods inherited from class org.pac4j.oauth.profile.definition.OAuthProfileDefinition
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, getLogger, getParameter, getPrimaryAttributes, getProfileFactory, getProfileId, getSecondaryAttributes, isRestoreProfileFromTypedId, newProfile, primary, secondary, setProfileFactory, setProfileId, setRestoreProfileFromTypedId
-
Field Details
-
REFERRAL_LINK
ConstantREFERRAL_LINK="referral_link"
- See Also:
-
COUNTRY
ConstantCOUNTRY="country"
- See Also:
-
EMAIL_VERIFIED
ConstantEMAIL_VERIFIED="email_verified"
- See Also:
-
-
Constructor Details
-
DropBoxProfileDefinition
public DropBoxProfileDefinition()Constructor for DropBoxProfileDefinition.
-
-
Method Details
-
getProfileUrl
public String getProfileUrl(com.github.scribejava.core.model.Token token, OAuthConfiguration configuration) Retrieve the url of the profile of the authenticated user for the provider.- Specified by:
getProfileUrl
in classOAuthProfileDefinition
- Parameters:
token
- 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
-
getProfileVerb
public com.github.scribejava.core.model.Verb getProfileVerb()Get HTTP Method to request profile.- Overrides:
getProfileVerb
in classOAuthProfileDefinition
- Returns:
- http verb
-
extractUserProfile
Extract the user profile from the response (JSON, XML...) of the profile url.- Specified by:
extractUserProfile
in classOAuthProfileDefinition
- Parameters:
body
- the response body- Returns:
- the returned profile
-