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
public class DropBoxProfileDefinition extends OAuthProfileDefinition
This class is the DropBox profile definition.
Since:
1.2.0
Author:
Jerome Leleu

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final String
    COUNTRY
    Constant COUNTRY="country"
    static final String
    EMAIL_VERIFIED
    Constant EMAIL_VERIFIED="email_verified"
    static final String
    REFERRAL_LINK
    Constant REFERRAL_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

    Constructors
    Constructor
    Description
    DropBoxProfileDefinition()
    Constructor for DropBoxProfileDefinition.

  • Method Summary

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

    Methods inherited from class java.lang.Object

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

  • Field Details

  • 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 class OAuthProfileDefinition
      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

    • getProfileVerb

      public com.github.scribejava.core.model.Verb getProfileVerb()
      Get HTTP Method to request profile.
      Overrides:
      getProfileVerb in class OAuthProfileDefinition
      Returns:
      http verb

    • extractUserProfile

      public DropBoxProfile extractUserProfile(String body)
      Extract the user profile from the response (JSON, XML...) of the profile url.
      Specified by:
      extractUserProfile in class OAuthProfileDefinition
      Parameters:
      body - the response body
      Returns:
      the returned profile