org.pac4j.oauth.profile.dropbox

Class DropBoxProfileDefinition

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<DropBoxProfile>

org.pac4j.oauth.profile.dropbox.DropBoxProfileDefinition

public class DropBoxProfileDefinition
extends OAuth20ProfileDefinition<DropBoxProfile>

This class is the DropBox profile definition.

Since:

1.2.0

Author:

Jerome Leleu

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	COUNTRY
static java.lang.String	EMAIL_VERIFIED
static java.lang.String	NORMAL
static java.lang.String	QUOTA
static java.lang.String	REFERRAL_LINK
static java.lang.String	SHARED

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

Constructor Summary

Constructors

Constructor and Description
DropBoxProfileDefinition()

Method Summary

Modifier and Type	Method and Description
DropBoxProfile	extractUserProfile(java.lang.String body) Extract the user profile from the response (JSON, XML...) of the profile url.
java.lang.String	getProfileUrl(com.github.scribejava.core.model.OAuth2AccessToken token, 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

REFERRAL_LINK

public static final java.lang.String REFERRAL_LINK

See Also:

Constant Field Values

COUNTRY

public static final java.lang.String COUNTRY

See Also:

Constant Field Values

SHARED

public static final java.lang.String SHARED

See Also:

Constant Field Values

QUOTA

public static final java.lang.String QUOTA

See Also:

Constant Field Values

NORMAL

public static final java.lang.String NORMAL

See Also:

Constant Field Values

EMAIL_VERIFIED

public static final java.lang.String EMAIL_VERIFIED

See Also:

Constant Field Values

Constructor Detail

DropBoxProfileDefinition

public DropBoxProfileDefinition()

Method Detail

getProfileUrl

public java.lang.String getProfileUrl(com.github.scribejava.core.model.OAuth2AccessToken token,
                                      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<DropBoxProfile,com.github.scribejava.core.model.OAuth2AccessToken,OAuth20Configuration>

Parameters:

token - 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 DropBoxProfile extractUserProfile(java.lang.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<DropBoxProfile,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