Package org.pac4j.oauth.profile.yahoo
Class YahooProfileDefinition
- 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<YahooProfile>
-
- org.pac4j.oauth.profile.yahoo.YahooProfileDefinition
-
public class YahooProfileDefinition extends OAuth10ProfileDefinition<YahooProfile>
This class is the Yahoo profile definition.- Since:
- 1.1.0
- Author:
- Jerome Leleu
-
-
Field Summary
Fields Modifier and Type Field Description static String
ABOUT_ME
static String
ADDRESSES
static String
AGE_CATEGORY
static String
BIRTH_YEAR
static String
BIRTHDATE
static String
CREATED
static String
DISCLOSURES
static String
DISPLAY_AGE
static String
EMAILS
static String
FAMILY_NAME
static String
GIVEN_NAME
static String
IMAGE
static String
INTERESTS
static String
IS_CONNECTED
static String
LANG
static String
MEMBER_SINCE
static String
NICKNAME
static String
PROFILE_URL
static String
TIME_ZONE
static String
UPDATED
static String
URI
-
Fields inherited from class org.pac4j.core.profile.definition.CommonProfileDefinition
DISPLAY_NAME, EMAIL, FIRST_NAME, GENDER, LOCALE, LOCATION, PICTURE_URL
-
Fields inherited from class org.pac4j.core.profile.definition.ProfileDefinition
logger, newProfile
-
-
Constructor Summary
Constructors Constructor Description YahooProfileDefinition()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description YahooProfile
extractUserProfile(String body)
Extract the user profile from the response (JSON, XML...) of the profile url.String
getProfileUrl(com.github.scribejava.core.model.OAuth1Token accessToken, 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, 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, getPrimaryAttributes, getProfileId, getSecondaryAttributes, newProfile, primary, secondary, setProfileFactory, setProfileId
-
-
-
-
Field Detail
-
ABOUT_ME
public static final String ABOUT_ME
- See Also:
- Constant Field Values
-
AGE_CATEGORY
public static final String AGE_CATEGORY
- See Also:
- Constant Field Values
-
ADDRESSES
public static final String ADDRESSES
- See Also:
- Constant Field Values
-
BIRTH_YEAR
public static final String BIRTH_YEAR
- See Also:
- Constant Field Values
-
BIRTHDATE
public static final String BIRTHDATE
- See Also:
- Constant Field Values
-
CREATED
public static final String CREATED
- See Also:
- Constant Field Values
-
DISPLAY_AGE
public static final String DISPLAY_AGE
- See Also:
- Constant Field Values
-
DISCLOSURES
public static final String DISCLOSURES
- See Also:
- Constant Field Values
-
EMAILS
public static final String EMAILS
- See Also:
- Constant Field Values
-
FAMILY_NAME
public static final String FAMILY_NAME
- See Also:
- Constant Field Values
-
GIVEN_NAME
public static final String GIVEN_NAME
- See Also:
- Constant Field Values
-
IMAGE
public static final String IMAGE
- See Also:
- Constant Field Values
-
INTERESTS
public static final String INTERESTS
- See Also:
- Constant Field Values
-
IS_CONNECTED
public static final String IS_CONNECTED
- See Also:
- Constant Field Values
-
LANG
public static final String LANG
- See Also:
- Constant Field Values
-
MEMBER_SINCE
public static final String MEMBER_SINCE
- See Also:
- Constant Field Values
-
NICKNAME
public static final String NICKNAME
- See Also:
- Constant Field Values
-
PROFILE_URL
public static final String PROFILE_URL
- See Also:
- Constant Field Values
-
TIME_ZONE
public static final String TIME_ZONE
- See Also:
- Constant Field Values
-
UPDATED
public static final String UPDATED
- See Also:
- Constant Field Values
-
URI
public static final String URI
- See Also:
- Constant Field Values
-
-
Method Detail
-
getProfileUrl
public String getProfileUrl(com.github.scribejava.core.model.OAuth1Token accessToken, OAuth10Configuration configuration)
Description copied from class:OAuthProfileDefinition
Retrieve the url of the profile of the authenticated user for the provider.- Specified by:
getProfileUrl
in classOAuthProfileDefinition<YahooProfile,com.github.scribejava.core.model.OAuth1Token,OAuth10Configuration>
- Parameters:
accessToken
- 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
-
extractUserProfile
public YahooProfile extractUserProfile(String body)
Description copied from class:OAuthProfileDefinition
Extract the user profile from the response (JSON, XML...) of the profile url.- Specified by:
extractUserProfile
in classOAuthProfileDefinition<YahooProfile,com.github.scribejava.core.model.OAuth1Token,OAuth10Configuration>
- Parameters:
body
- the response body- Returns:
- the returned profile
-
-