Package org.pac4j.oauth.profile.facebook

Class FacebookProfileDefinition

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.OAuth2AccessToken,C>

org.pac4j.oauth.profile.definition.OAuth20ProfileDefinition<FacebookProfile,FacebookConfiguration>

org.pac4j.oauth.profile.facebook.FacebookProfileDefinition

public class FacebookProfileDefinition
extends OAuth20ProfileDefinition<FacebookProfile,FacebookConfiguration>

This class is the Facebook profile definition.

Since:

1.1.0

Author:

Jerome Leleu

Field Summary

Fields

Modifier and Type	Field	Description
static String	ABOUT
static String	ALBUMS
protected static String	APPSECRET_PARAMETER
protected static String	BASE_URL
static String	BIRTHDAY
static String	BOOKS
static int	DEFAULT_LIMIT
static String	EDUCATION
static String	EVENTS
static String	FAVORITE_ATHLETES
static String	FAVORITE_TEAMS
static String	FRIENDS
static String	GROUPS
static String	HOMETOWN
static String	INTERESTED_IN
static String	LANGUAGES
static String	LAST_NAME
static String	LIKES
static String	LINK
static String	MIDDLE_NAME
static String	MOVIES
static String	MUSIC
static String	MUSIC_LISTENS
static String	NAME
static String	PICTURE
static String	POLITICAL
static String	QUOTES
static String	RELATIONSHIP_STATUS
static String	RELIGION
static String	SIGNIFICANT_OTHER
static String	THIRD_PARTY_ID
static String	TIMEZONE
static String	UPDATED_TIME
static String	VERIFIED
static String	WEBSITE
static String	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, newProfile

Constructor Summary

Constructors

Constructor	Description
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(FacebookProfile profile, com.fasterxml.jackson.databind.JsonNode json, String name)
FacebookProfile	extractUserProfile(String body)	Extract the user profile from the response (JSON, XML...) of the profile url.
String	getProfileUrl(com.github.scribejava.core.model.OAuth2AccessToken accessToken, FacebookConfiguration 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

Methods inherited from class java.lang.Object

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

Field Detail

NAME

public static final String NAME

See Also:

Constant Field Values

MIDDLE_NAME

public static final String MIDDLE_NAME

See Also:

Constant Field Values

LAST_NAME

public static final String LAST_NAME

See Also:

Constant Field Values

LANGUAGES

public static final String LANGUAGES

See Also:

Constant Field Values

LINK

public static final String LINK

See Also:

Constant Field Values

THIRD_PARTY_ID

public static final String THIRD_PARTY_ID

See Also:

Constant Field Values

TIMEZONE

public static final String TIMEZONE

See Also:

Constant Field Values

UPDATED_TIME

public static final String UPDATED_TIME

See Also:

Constant Field Values

VERIFIED

public static final String VERIFIED

See Also:

Constant Field Values

ABOUT

public static final String ABOUT

See Also:

Constant Field Values

BIRTHDAY

public static final String BIRTHDAY

See Also:

Constant Field Values

EDUCATION

public static final String EDUCATION

See Also:

Constant Field Values

HOMETOWN

public static final String HOMETOWN

See Also:

Constant Field Values

INTERESTED_IN

public static final String INTERESTED_IN

See Also:

Constant Field Values

POLITICAL

public static final String POLITICAL

See Also:

Constant Field Values

FAVORITE_ATHLETES

public static final String FAVORITE_ATHLETES

See Also:

Constant Field Values

FAVORITE_TEAMS

public static final String FAVORITE_TEAMS

See Also:

Constant Field Values

QUOTES

public static final String QUOTES

See Also:

Constant Field Values

RELATIONSHIP_STATUS

public static final String RELATIONSHIP_STATUS

See Also:

Constant Field Values

RELIGION

public static final String RELIGION

See Also:

Constant Field Values

SIGNIFICANT_OTHER

public static final String SIGNIFICANT_OTHER

See Also:

Constant Field Values

WEBSITE

public static final String WEBSITE

See Also:

Constant Field Values

WORK

public static final String WORK

See Also:

Constant Field Values

FRIENDS

public static final String FRIENDS

See Also:

Constant Field Values

MOVIES

public static final String MOVIES

See Also:

Constant Field Values

MUSIC

public static final String MUSIC

See Also:

Constant Field Values

BOOKS

public static final String BOOKS

See Also:

Constant Field Values

LIKES

public static final String LIKES

See Also:

Constant Field Values

ALBUMS

public static final String ALBUMS

See Also:

Constant Field Values

EVENTS

public static final String EVENTS

See Also:

Constant Field Values

GROUPS

public static final String GROUPS

See Also:

Constant Field Values

MUSIC_LISTENS

public static final String MUSIC_LISTENS

See Also:

Constant Field Values

PICTURE

public static final String PICTURE

See Also:

Constant Field Values

DEFAULT_LIMIT

public static final int DEFAULT_LIMIT

See Also:

Constant Field Values

BASE_URL

protected static final String BASE_URL

See Also:

Constant Field Values

APPSECRET_PARAMETER

protected static final String APPSECRET_PARAMETER

See Also:

Constant Field Values

Constructor Detail

FacebookProfileDefinition

public FacebookProfileDefinition()

Method Detail

getProfileUrl

public String getProfileUrl(com.github.scribejava.core.model.OAuth2AccessToken accessToken,
                            FacebookConfiguration 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<FacebookProfile,com.github.scribejava.core.model.OAuth2AccessToken,FacebookConfiguration>

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)

Description copied from class: OAuthProfileDefinition

Extract the user profile from the response (JSON, XML...) of the profile url.

Specified by:

extractUserProfile in class OAuthProfileDefinition<FacebookProfile,com.github.scribejava.core.model.OAuth2AccessToken,FacebookConfiguration>

Parameters:

body - the response body

Returns:

the returned profile

extractData

protected void extractData(FacebookProfile profile,
                           com.fasterxml.jackson.databind.JsonNode json,
                           String name)