org.pac4j.oauth.client

Class FacebookClient

java.lang.Object

org.pac4j.core.util.InitializableObject

org.pac4j.core.client.BaseClient<OAuthCredentials,U>

org.pac4j.oauth.client.BaseOAuthClient<U>

org.pac4j.oauth.client.BaseOAuth20Client<FacebookProfile>

org.pac4j.oauth.client.FacebookClient

All Implemented Interfaces:

Cloneable, Client<OAuthCredentials,FacebookProfile>

public class FacebookClient
extends BaseOAuth20Client<FacebookProfile>

This class is the OAuth client to authenticate users in Facebook.

By default, the following scope is requested to Facebook : user_likes, user_about_me, user_birthday, user_education_history, email, user_hometown, user_relationship_details, user_location, user_religion_politics, user_relationships, user_website and user_work_history.

The scope can be defined to require permissions from the user and retrieve fields from Facebook, by using the setScope(String) method.

By default, the following fields are requested to Facebook : id, name, first_name, middle_name, last_name, gender, locale, languages, link, username, third_party_id, timezone, updated_time, verified, bio, birthday, education, email, hometown, interested_in, location, political, favorite_athletes, favorite_teams, quotes, relationship_status, religion, significant_other, website and work.

The fields can be defined and requested to Facebook, by using the setFields(String) method.

The number of results can be limited by using the setLimit(int) method.

An extended access token can be requested by setting true on the setRequiresExtendedToken(boolean) method.

It returns a FacebookProfile.

More information at http://developers.facebook.com/docs/reference/api/user/

More information at https://developers.facebook.com/docs/howtos/login/extending-tokens/

Since:

1.0.0

Author:

Jerome Leleu, Mehdi BEN HAJ ABBES

See Also:

FacebookProfile

Field Summary

Fields

Modifier and Type	Field and Description
protected StateApi20	api20
protected static String	BASE_URL
static String	DEFAULT_FIELDS
static int	DEFAULT_LIMIT
static String	DEFAULT_SCOPE
protected String	fields
protected int	limit
protected boolean	requiresExtendedToken
protected String	scope

Fields inherited from class org.pac4j.oauth.client.BaseOAuth20Client

logger, OAUTH_CODE

Fields inherited from class org.pac4j.oauth.client.BaseOAuthClient

connectTimeout, key, proxyHost, proxyPort, readTimeout, secret, service, tokenAsHeader

Fields inherited from class org.pac4j.core.client.BaseClient

ATTEMPTED_AUTHENTICATION_SUFFIX, callbackUrl, NEEDS_CLIENT_REDIRECTION_PARAMETER

Constructor Summary

Constructors

Constructor and Description
FacebookClient()
FacebookClient(String key, String secret)

Method Summary

Modifier and Type	Method and Description
protected void	extractData(FacebookProfile profile, com.fasterxml.jackson.databind.JsonNode json, String name)
protected FacebookProfile	extractUserProfile(String body) Extract the user profile from the response (JSON, XML...) of the profile url.
String	getFields()
int	getLimit()
protected String	getProfileUrl(org.scribe.model.Token accessToken) Retrieve the url of the profile of the authenticated user for the provider.
String	getScope()
protected boolean	hasBeenCancelled(WebContext context) Return if the authentication has been cancelled.
protected void	internalInit()
boolean	isRequiresExtendedToken()
protected FacebookClient	newClient()
protected boolean	requiresStateParameter() Return if this client requires a state parameter.
protected FacebookProfile	retrieveUserProfileFromToken(org.scribe.model.Token accessToken) Retrieve the user profile from the access token.
void	setFields(String fields)
void	setLimit(int limit)
void	setRequiresExtendedToken(boolean requiresExtendedToken)
void	setScope(String scope)

Methods inherited from class org.pac4j.oauth.client.BaseOAuth20Client

getAccessToken, getOAuthCredentials, getStateParameter, isDirectRedirection, retrieveAuthorizationUrl

Methods inherited from class org.pac4j.oauth.client.BaseOAuthClient

addAccessTokenToProfile, clone, createProxyRequest, getConnectTimeout, getKey, getMechanism, getProxyHost, getProxyPort, getReadTimeout, getSecret, getUserProfile, isTokenAsHeader, retrieveCredentials, retrieveRedirectAction, retrieveUserProfile, sendRequestForData, sendRequestForData, setConnectTimeout, setKey, setProxyHost, setProxyPort, setReadTimeout, setSecret, setTokenAsHeader

Methods inherited from class org.pac4j.core.client.BaseClient

addAuthorizationGenerator, getAuthenticator, getAuthorizationGenerators, getCallbackUrl, getContextualCallbackUrl, getCredentials, getName, getProfileCreator, getRedirectAction, getRedirectionUrl, getUserProfile, isEnableContextualRedirects, isIncludeClientNameInCallbackUrl, prependHostToUrlIfNotPresent, redirect, setAuthenticator, setAuthorizationGenerator, setAuthorizationGenerators, setCallbackUrl, setEnableContextualRedirects, setIncludeClientNameInCallbackUrl, setName, setProfileCreator, toString

Methods inherited from class org.pac4j.core.util.InitializableObject

init, reinit

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_FIELDS

public static final String DEFAULT_FIELDS

See Also:

Constant Field Values

fields

protected String fields

BASE_URL

protected static final String BASE_URL

See Also:

Constant Field Values

DEFAULT_SCOPE

public static final String DEFAULT_SCOPE

See Also:

Constant Field Values

scope

protected String scope

DEFAULT_LIMIT

public static final int DEFAULT_LIMIT

See Also:

Constant Field Values

limit

protected int limit

requiresExtendedToken

protected boolean requiresExtendedToken

api20

protected StateApi20 api20

Constructor Detail

FacebookClient

public FacebookClient()

FacebookClient

public FacebookClient(String key,
                      String secret)

Method Detail

newClient

protected FacebookClient newClient()

Specified by:

newClient in class BaseClient<OAuthCredentials,FacebookProfile>

internalInit

protected void internalInit()

Overrides:

internalInit in class BaseOAuthClient<FacebookProfile>

getProfileUrl

protected String getProfileUrl(org.scribe.model.Token accessToken)

Description copied from class: BaseOAuthClient

Retrieve the url of the profile of the authenticated user for the provider.

Specified by:

getProfileUrl in class BaseOAuthClient<FacebookProfile>

Parameters:

accessToken - only used when constructing dynamic urls from data in the token

Returns:

the url of the user profile given by the provider

retrieveUserProfileFromToken

protected FacebookProfile retrieveUserProfileFromToken(org.scribe.model.Token accessToken)

Description copied from class: BaseOAuthClient

Retrieve the user profile from the access token.

Overrides:

retrieveUserProfileFromToken in class BaseOAuthClient<FacebookProfile>

Parameters:

accessToken - the access token

Returns:

the user profile

extractUserProfile

protected FacebookProfile extractUserProfile(String body)

Description copied from class: BaseOAuthClient

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

Specified by:

extractUserProfile in class BaseOAuthClient<FacebookProfile>

Parameters:

body - the response body

Returns:

the user profile object

extractData

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

hasBeenCancelled

protected boolean hasBeenCancelled(WebContext context)

Description copied from class: BaseOAuthClient

Return if the authentication has been cancelled.

Specified by:

hasBeenCancelled in class BaseOAuthClient<FacebookProfile>

Parameters:

context - the web context.

Returns:

if the authentication has been cancelled.

getScope

public String getScope()

setScope

public void setScope(String scope)

getFields

public String getFields()

setFields

public void setFields(String fields)

getLimit

public int getLimit()

setLimit

public void setLimit(int limit)

isRequiresExtendedToken

public boolean isRequiresExtendedToken()

setRequiresExtendedToken

public void setRequiresExtendedToken(boolean requiresExtendedToken)

requiresStateParameter

protected boolean requiresStateParameter()

Description copied from class: BaseOAuth20Client

Return if this client requires a state parameter.

Specified by:

requiresStateParameter in class BaseOAuth20Client<FacebookProfile>

Returns:

if this client requires a state parameter.