org.pac4j.oauth.profile.bitbucket

Class BitbucketProfileDefinition

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.OAuth1Token,OAuth10Configuration>

org.pac4j.oauth.profile.definition.OAuth10ProfileDefinition<BitbucketProfile>

org.pac4j.oauth.profile.bitbucket.BitbucketProfileDefinition

public class BitbucketProfileDefinition
extends OAuth10ProfileDefinition<BitbucketProfile>

This class is the Bitbucket profile definition.

Since:

1.5.1

Author:

Sebastian Sdorra

Field Summary

Fields

Modifier and Type	Field and Description
static String	AVATAR
static String	IS_TEAM
static String	LAST_NAME
static String	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, newProfile

Constructor Summary

Constructors

Constructor and Description
BitbucketProfileDefinition()

Method Summary

Modifier and Type	Method and 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.OAuth1Token token, OAuth10Configuration 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

LAST_NAME

public static final String LAST_NAME

See Also:

Constant Field Values

IS_TEAM

public static final String IS_TEAM

See Also:

Constant Field Values

AVATAR

public static final String AVATAR

See Also:

Constant Field Values

RESOURCE_URI

public static final String RESOURCE_URI

See Also:

Constant Field Values

Constructor Detail

BitbucketProfileDefinition

public BitbucketProfileDefinition()

Method Detail

getProfileUrl

public String getProfileUrl(com.github.scribejava.core.model.OAuth1Token token,
                            OAuth10Configuration 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<BitbucketProfile,com.github.scribejava.core.model.OAuth1Token,OAuth10Configuration>

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)
                                    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<BitbucketProfile,com.github.scribejava.core.model.OAuth1Token,OAuth10Configuration>

Parameters:

body - the response body

Returns:

the returned profile

Throws:

HttpAction - whether an extra HTTP action is required