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