Package org.pac4j.oauth.profile.bitbucket

Class BitbucketProfileDefinition

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.bitbucket.BitbucketProfileDefinition
public class BitbucketProfileDefinition extends OAuthProfileDefinition
This class is the Bitbucket profile definition.
Since:
1.5.1
Author:
Sebastian Sdorra

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final String
    AVATAR
    Constant AVATAR="avatar"
    static final String
    IS_TEAM
    Constant IS_TEAM="is_team"
    static final String
    LAST_NAME
    Constant LAST_NAME="last_name"
    static final String
    RESOURCE_URI
    Constant RESOURCE_URI="resource_uri"

    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
    BitbucketProfileDefinition()
    Constructor for BitbucketProfileDefinition.

  • Method Summary

    Modifier and Type
    Method
    Description
    BitbucketProfile
    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.

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

    • BitbucketProfileDefinition

      public BitbucketProfileDefinition()

      Constructor for BitbucketProfileDefinition.

  • 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

    • extractUserProfile

      public BitbucketProfile 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