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	Constant ABOUT_ME="aboutMe"
static final String	ADDRESSES	Constant ADDRESSES="addresses"
static final String	AGE_CATEGORY	Constant AGE_CATEGORY="ageCategory"
static final String	BIRTH_YEAR	Constant BIRTH_YEAR="birthYear"
static final String	BIRTHDATE	Constant BIRTHDATE="birthdate"
static final String	CREATED	Constant CREATED="created"
static final String	DISCLOSURES	Constant DISCLOSURES="disclosures"
static final String	DISPLAY_AGE	Constant DISPLAY_AGE="displayAge"
static final String	EMAILS	Constant EMAILS="emails"
static final String	FAMILY_NAME	Constant FAMILY_NAME="familyName"
static final String	GIVEN_NAME	Constant GIVEN_NAME="givenName"
static final String	IMAGE	Constant IMAGE="image"
static final String	INTERESTS	Constant INTERESTS="interests"
static final String	IS_CONNECTED	Constant IS_CONNECTED="isConnected"
static final String	LANG	Constant LANG="lang"
static final String	MEMBER_SINCE	Constant MEMBER_SINCE="memberSince"
static final String	NICKNAME	Constant NICKNAME="nickname"
static final String	PROFILE_URL	Constant PROFILE_URL="profileUrl"
static final String	TIME_ZONE	Constant TIME_ZONE="timeZone"
static final String	UPDATED	Constant UPDATED="updated"
static final String	URI	Constant URI="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()	Constructor for 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, 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

ABOUT_ME

public static final String ABOUT_ME

Constant ABOUT_ME="aboutMe"

See Also:

• Constant Field Values

AGE_CATEGORY

public static final String AGE_CATEGORY

Constant AGE_CATEGORY="ageCategory"

See Also:

• Constant Field Values

ADDRESSES

public static final String ADDRESSES

Constant ADDRESSES="addresses"

See Also:

• Constant Field Values

BIRTH_YEAR

public static final String BIRTH_YEAR

Constant BIRTH_YEAR="birthYear"

See Also:

• Constant Field Values

BIRTHDATE

public static final String BIRTHDATE

Constant BIRTHDATE="birthdate"

See Also:

• Constant Field Values

CREATED

public static final String CREATED

Constant CREATED="created"

See Also:

• Constant Field Values

DISPLAY_AGE

public static final String DISPLAY_AGE

Constant DISPLAY_AGE="displayAge"

See Also:

• Constant Field Values

DISCLOSURES

public static final String DISCLOSURES

Constant DISCLOSURES="disclosures"

See Also:

• Constant Field Values

EMAILS

public static final String EMAILS

Constant EMAILS="emails"

See Also:

• Constant Field Values

FAMILY_NAME

public static final String FAMILY_NAME

Constant FAMILY_NAME="familyName"

See Also:

• Constant Field Values

GIVEN_NAME

public static final String GIVEN_NAME

Constant GIVEN_NAME="givenName"

See Also:

• Constant Field Values

IMAGE

public static final String IMAGE

Constant IMAGE="image"

See Also:

• Constant Field Values

INTERESTS

public static final String INTERESTS

Constant INTERESTS="interests"

See Also:

• Constant Field Values

IS_CONNECTED

public static final String IS_CONNECTED

Constant IS_CONNECTED="isConnected"

See Also:

• Constant Field Values

LANG

public static final String LANG

Constant LANG="lang"

See Also:

• Constant Field Values

MEMBER_SINCE

public static final String MEMBER_SINCE

Constant MEMBER_SINCE="memberSince"

See Also:

• Constant Field Values

NICKNAME

public static final String NICKNAME

Constant NICKNAME="nickname"

See Also:

• Constant Field Values

PROFILE_URL

public static final String PROFILE_URL

Constant PROFILE_URL="profileUrl"

See Also:

• Constant Field Values

TIME_ZONE

public static final String TIME_ZONE

Constant TIME_ZONE="timeZone"

See Also:

• Constant Field Values

UPDATED

public static final String UPDATED

Constant UPDATED="updated"

See Also:

• Constant Field Values

URI

public static final String URI

Constant URI="uri"

See Also:

• Constant Field Values

Constructor Details

YahooProfileDefinition

public YahooProfileDefinition()

Constructor for YahooProfileDefinition.

Method Details

getProfileUrl

public String getProfileUrl(com.github.scribejava.core.model.Token accessToken,
 OAuthConfiguration configuration)

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)

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