FacebookProfileDefinition (pac4j for OAuth protocol 3.0.1 API)

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

FacebookProfileDefinition()

Constructors
Constructor and Description
`FacebookProfileDefinition()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`java.lang.String`	`computeAppSecretProof(java.lang.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, java.lang.String name)`
`FacebookProfile`	`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.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

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 java.lang.String NAME
```
    See Also:
    
    Constant Field Values
  - MIDDLE_NAME
```
public static final java.lang.String MIDDLE_NAME
```
    See Also:
    
    Constant Field Values
  - LAST_NAME
```
public static final java.lang.String LAST_NAME
```
    See Also:
    
    Constant Field Values
  - LANGUAGES
```
public static final java.lang.String LANGUAGES
```
    See Also:
    
    Constant Field Values
  - LINK
```
public static final java.lang.String LINK
```
    See Also:
    
    Constant Field Values
  - THIRD_PARTY_ID
```
public static final java.lang.String THIRD_PARTY_ID
```
    See Also:
    
    Constant Field Values
  - TIMEZONE
```
public static final java.lang.String TIMEZONE
```
    See Also:
    
    Constant Field Values
  - UPDATED_TIME
```
public static final java.lang.String UPDATED_TIME
```
    See Also:
    
    Constant Field Values
  - VERIFIED
```
public static final java.lang.String VERIFIED
```
    See Also:
    
    Constant Field Values
  - ABOUT
```
public static final java.lang.String ABOUT
```
    See Also:
    
    Constant Field Values
  - BIRTHDAY
```
public static final java.lang.String BIRTHDAY
```
    See Also:
    
    Constant Field Values
  - EDUCATION
```
public static final java.lang.String EDUCATION
```
    See Also:
    
    Constant Field Values
  - HOMETOWN
```
public static final java.lang.String HOMETOWN
```
    See Also:
    
    Constant Field Values
  - INTERESTED_IN
```
public static final java.lang.String INTERESTED_IN
```
    See Also:
    
    Constant Field Values
  - POLITICAL
```
public static final java.lang.String POLITICAL
```
    See Also:
    
    Constant Field Values
  - FAVORITE_ATHLETES
```
public static final java.lang.String FAVORITE_ATHLETES
```
    See Also:
    
    Constant Field Values
  - FAVORITE_TEAMS
```
public static final java.lang.String FAVORITE_TEAMS
```
    See Also:
    
    Constant Field Values
  - QUOTES
```
public static final java.lang.String QUOTES
```
    See Also:
    
    Constant Field Values
  - RELATIONSHIP_STATUS
```
public static final java.lang.String RELATIONSHIP_STATUS
```
    See Also:
    
    Constant Field Values
  - RELIGION
```
public static final java.lang.String RELIGION
```
    See Also:
    
    Constant Field Values
  - SIGNIFICANT_OTHER
```
public static final java.lang.String SIGNIFICANT_OTHER
```
    See Also:
    
    Constant Field Values
  - WEBSITE
```
public static final java.lang.String WEBSITE
```
    See Also:
    
    Constant Field Values
  - WORK
```
public static final java.lang.String WORK
```
    See Also:
    
    Constant Field Values
  - FRIENDS
```
public static final java.lang.String FRIENDS
```
    See Also:
    
    Constant Field Values
  - MOVIES
```
public static final java.lang.String MOVIES
```
    See Also:
    
    Constant Field Values
  - MUSIC
```
public static final java.lang.String MUSIC
```
    See Also:
    
    Constant Field Values
  - BOOKS
```
public static final java.lang.String BOOKS
```
    See Also:
    
    Constant Field Values
  - LIKES
```
public static final java.lang.String LIKES
```
    See Also:
    
    Constant Field Values
  - ALBUMS
```
public static final java.lang.String ALBUMS
```
    See Also:
    
    Constant Field Values
  - EVENTS
```
public static final java.lang.String EVENTS
```
    See Also:
    
    Constant Field Values
  - GROUPS
```
public static final java.lang.String GROUPS
```
    See Also:
    
    Constant Field Values
  - MUSIC_LISTENS
```
public static final java.lang.String MUSIC_LISTENS
```
    See Also:
    
    Constant Field Values
  - PICTURE
```
public static final java.lang.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 java.lang.String BASE_URL
```
    See Also:
    
    Constant Field Values
  - APPSECRET_PARAMETER
```
protected static final java.lang.String APPSECRET_PARAMETER
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - FacebookProfileDefinition
```
public FacebookProfileDefinition()
```
- Method Detail
  - getProfileUrl
```
public java.lang.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 java.lang.String computeAppSecretProof(java.lang.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(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 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,
                           java.lang.String name)
```

Class FacebookProfileDefinition

Field Summary

Fields inherited from class org.pac4j.core.profile.definition.CommonProfileDefinition

Fields inherited from class org.pac4j.core.profile.definition.ProfileDefinition

Constructor Summary

Method Summary

Methods inherited from class org.pac4j.oauth.profile.definition.OAuthProfileDefinition

Methods inherited from class org.pac4j.core.profile.definition.ProfileDefinition

Methods inherited from class java.lang.Object

Field Detail

NAME

MIDDLE_NAME

LAST_NAME

LANGUAGES

LINK

THIRD_PARTY_ID

TIMEZONE

UPDATED_TIME

VERIFIED

ABOUT

BIRTHDAY

EDUCATION

HOMETOWN

INTERESTED_IN

POLITICAL

FAVORITE_ATHLETES

FAVORITE_TEAMS

QUOTES

RELATIONSHIP_STATUS

RELIGION

SIGNIFICANT_OTHER

WEBSITE

WORK

FRIENDS

MOVIES

MUSIC

BOOKS

LIKES

ALBUMS

EVENTS

GROUPS

MUSIC_LISTENS

PICTURE

DEFAULT_LIMIT

BASE_URL

APPSECRET_PARAMETER

Constructor Detail

FacebookProfileDefinition

Method Detail

getProfileUrl

computeAppSecretProof

extractUserProfile

extractData