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 final String	ABOUT_ME
static final String	ADDRESSES
static final String	AGE_CATEGORY
static final String	BIRTH_YEAR
static final String	BIRTHDATE
static final String	CREATED
static final String	DISCLOSURES
static final String	DISPLAY_AGE
static final String	EMAILS
static final String	FAMILY_NAME
static final String	GIVEN_NAME
static final String	IMAGE
static final String	INTERESTS
static final String	IS_CONNECTED
static final String	LANG
static final String	MEMBER_SINCE
static final String	NICKNAME
static final String	PROFILE_URL
static final String	TIME_ZONE
static final String	UPDATED
static final 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

Constructor Summary

Constructors

Constructor	Description
YahooProfileDefinition()

Method Summary

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

Methods inherited from class java.lang.Object

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

Field Details

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

Constructor Details

YahooProfileDefinition

public YahooProfileDefinition()

Method Details

getProfileUrl

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

Parameters:

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

Parameters:

body - the response body

Returns:

the returned profile