Package org.pac4j.oauth.profile.facebook

Class FacebookProfileDefinition

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

public class FacebookProfileDefinition
extends OAuthProfileDefinition

This class is the Facebook profile definition.

Since:

1.1.0

Author:

Jerome Leleu

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ABOUT	Constant ABOUT="about"
static final String	ALBUMS	Constant ALBUMS="albums"
protected static final String	APPSECRET_PARAMETER	Constant APPSECRET_PARAMETER="appsecret_proof"
protected static final String	BASE_URL	Constant BASE_URL="https://graph.facebook.com/v2.8/me"
static final String	BIRTHDAY	Constant BIRTHDAY="birthday"
static final String	BOOKS	Constant BOOKS="books"
static final int	DEFAULT_LIMIT	Constant DEFAULT_LIMIT=0
static final String	EDUCATION	Constant EDUCATION="education"
static final String	EVENTS	Constant EVENTS="events"
static final String	FAVORITE_ATHLETES	Constant FAVORITE_ATHLETES="favorite_athletes"
static final String	FAVORITE_TEAMS	Constant FAVORITE_TEAMS="favorite_teams"
static final String	FRIENDS	Constant FRIENDS="friends"
static final String	GROUPS	Constant GROUPS="groups"
static final String	HOMETOWN	Constant HOMETOWN="hometown"
static final String	INTERESTED_IN	Constant INTERESTED_IN="interested_in"
static final String	LANGUAGES	Constant LANGUAGES="languages"
static final String	LAST_NAME	Constant LAST_NAME="last_name"
static final String	LIKES	Constant LIKES="likes"
static final String	LINK	Constant LINK="link"
static final String	MIDDLE_NAME	Constant MIDDLE_NAME="middle_name"
static final String	MOVIES	Constant MOVIES="movies"
static final String	MUSIC	Constant MUSIC="music"
static final String	MUSIC_LISTENS	Constant MUSIC_LISTENS="music.listens"
static final String	NAME	Constant NAME="name"
static final String	PICTURE	Constant PICTURE="picture"
static final String	POLITICAL	Constant POLITICAL="political"
static final String	QUOTES	Constant QUOTES="quotes"
static final String	RELATIONSHIP_STATUS	Constant RELATIONSHIP_STATUS="relationship_status"
static final String	RELIGION	Constant RELIGION="religion"
static final String	SIGNIFICANT_OTHER	Constant SIGNIFICANT_OTHER="significant_other"
static final String	THIRD_PARTY_ID	Constant THIRD_PARTY_ID="third_party_id"
static final String	TIMEZONE	Constant TIMEZONE="timezone"
static final String	UPDATED_TIME	Constant UPDATED_TIME="updated_time"
static final String	VERIFIED	Constant VERIFIED="verified"
static final String	WEBSITE	Constant WEBSITE="website"
static final String	WORK	Constant WORK="work"

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

Constructor Summary

Constructors

Constructor	Description
FacebookProfileDefinition()	Constructor for FacebookProfileDefinition.

Method Summary

Modifier and Type	Method	Description
String	computeAppSecretProof(String url, com.github.scribejava.core.model.OAuth2AccessToken token, FacebookConfiguration configuration)	The code in this method is based on this blog post: https://www.sammyk.me/the-single-most-important-way-to-make-your-facebook-app-more-secure and this answer: https://stackoverflow.com/questions/7124735/hmac-sha256-algorithm-for-signature-calculation
protected void	extractData(org.pac4j.core.profile.UserProfile profile, com.fasterxml.jackson.databind.JsonNode json, String name)	extractData.
FacebookProfile	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

NAME

public static final String NAME

Constant NAME="name"

See Also:

• Constant Field Values

MIDDLE_NAME

public static final String MIDDLE_NAME

Constant MIDDLE_NAME="middle_name"

See Also:

• Constant Field Values

LAST_NAME

public static final String LAST_NAME

Constant LAST_NAME="last_name"

See Also:

• Constant Field Values

LANGUAGES

public static final String LANGUAGES

Constant LANGUAGES="languages"

See Also:

• Constant Field Values

LINK

public static final String LINK

Constant LINK="link"

See Also:

• Constant Field Values

THIRD_PARTY_ID

public static final String THIRD_PARTY_ID

Constant THIRD_PARTY_ID="third_party_id"

See Also:

• Constant Field Values

TIMEZONE

public static final String TIMEZONE

Constant TIMEZONE="timezone"

See Also:

• Constant Field Values

UPDATED_TIME

public static final String UPDATED_TIME

Constant UPDATED_TIME="updated_time"

See Also:

• Constant Field Values

VERIFIED

public static final String VERIFIED

Constant VERIFIED="verified"

See Also:

• Constant Field Values

ABOUT

public static final String ABOUT

Constant ABOUT="about"

See Also:

• Constant Field Values

BIRTHDAY

public static final String BIRTHDAY

Constant BIRTHDAY="birthday"

See Also:

• Constant Field Values

EDUCATION

public static final String EDUCATION

Constant EDUCATION="education"

See Also:

• Constant Field Values

HOMETOWN

public static final String HOMETOWN

Constant HOMETOWN="hometown"

See Also:

• Constant Field Values

INTERESTED_IN

public static final String INTERESTED_IN

Constant INTERESTED_IN="interested_in"

See Also:

• Constant Field Values

POLITICAL

public static final String POLITICAL

Constant POLITICAL="political"

See Also:

• Constant Field Values

FAVORITE_ATHLETES

public static final String FAVORITE_ATHLETES

Constant FAVORITE_ATHLETES="favorite_athletes"

See Also:

• Constant Field Values

FAVORITE_TEAMS

public static final String FAVORITE_TEAMS

Constant FAVORITE_TEAMS="favorite_teams"

See Also:

• Constant Field Values

QUOTES

public static final String QUOTES

Constant QUOTES="quotes"

See Also:

• Constant Field Values

RELATIONSHIP_STATUS

public static final String RELATIONSHIP_STATUS

Constant RELATIONSHIP_STATUS="relationship_status"

See Also:

• Constant Field Values

RELIGION

public static final String RELIGION

Constant RELIGION="religion"

See Also:

• Constant Field Values

SIGNIFICANT_OTHER

public static final String SIGNIFICANT_OTHER

Constant SIGNIFICANT_OTHER="significant_other"

See Also:

• Constant Field Values

WEBSITE

public static final String WEBSITE

Constant WEBSITE="website"

See Also:

• Constant Field Values

WORK

public static final String WORK

Constant WORK="work"

See Also:

• Constant Field Values

FRIENDS

public static final String FRIENDS

Constant FRIENDS="friends"

See Also:

• Constant Field Values

MOVIES

public static final String MOVIES

Constant MOVIES="movies"

See Also:

• Constant Field Values

MUSIC

public static final String MUSIC

Constant MUSIC="music"

See Also:

• Constant Field Values

BOOKS

public static final String BOOKS

Constant BOOKS="books"

See Also:

• Constant Field Values

LIKES

public static final String LIKES

Constant LIKES="likes"

See Also:

• Constant Field Values

ALBUMS

public static final String ALBUMS

Constant ALBUMS="albums"

See Also:

• Constant Field Values

EVENTS

public static final String EVENTS

Constant EVENTS="events"

See Also:

• Constant Field Values

GROUPS

public static final String GROUPS

Constant GROUPS="groups"

See Also:

• Constant Field Values

MUSIC_LISTENS

public static final String MUSIC_LISTENS

Constant MUSIC_LISTENS="music.listens"

See Also:

• Constant Field Values

PICTURE

public static final String PICTURE

Constant PICTURE="picture"

See Also:

• Constant Field Values

DEFAULT_LIMIT

public static final int DEFAULT_LIMIT

Constant DEFAULT_LIMIT=0

See Also:

• Constant Field Values

BASE_URL

protected static final String BASE_URL

Constant BASE_URL="https://graph.facebook.com/v2.8/me"

See Also:

• Constant Field Values

APPSECRET_PARAMETER

protected static final String APPSECRET_PARAMETER

Constant APPSECRET_PARAMETER="appsecret_proof"

See Also:

• Constant Field Values

Constructor Details

FacebookProfileDefinition

public FacebookProfileDefinition()

Constructor for FacebookProfileDefinition.

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

computeAppSecretProof

public String computeAppSecretProof(String url,
 com.github.scribejava.core.model.OAuth2AccessToken token,
 FacebookConfiguration configuration)

The code in this method is based on this blog post: https://www.sammyk.me/the-single-most-important-way-to-make-your-facebook-app-more-secure and this answer: https://stackoverflow.com/questions/7124735/hmac-sha256-algorithm-for-signature-calculation

Parameters:

url - the URL to which we're adding the proof

token - the application token we pass back and forth

configuration - the current configuration

Returns:

URL with the appsecret_proof parameter added

extractUserProfile

public FacebookProfile 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

extractData

protected void extractData(org.pac4j.core.profile.UserProfile profile,
 com.fasterxml.jackson.databind.JsonNode json,
 String name)

extractData.

Parameters:

profile - a FacebookProfile object

json - a JsonNode object

name - a String object