org.pac4j.oauth.client

Class FacebookClient

java.lang.Object

org.pac4j.core.util.InitializableWebObject

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

org.pac4j.core.client.IndirectClient<OAuth20Credentials,U>

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

org.pac4j.oauth.client.FacebookClient

All Implemented Interfaces:

Client<OAuth20Credentials,FacebookProfile>

public class FacebookClient
extends OAuth20Client<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, third_party_id, timezone, updated_time, verified, about, 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

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	DEFAULT_FIELDS
static java.lang.String	DEFAULT_SCOPE
protected java.lang.String	fields
protected int	limit
protected boolean	requiresExtendedToken
protected java.lang.String	scope
protected boolean	useAppsecretProof

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

configuration

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

ATTEMPTED_AUTHENTICATION_SUFFIX, callbackUrl, urlResolver

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

logger

Constructor Summary

Constructors

Constructor and Description
FacebookClient()
FacebookClient(java.lang.String key, java.lang.String secret)

Method Summary

Modifier and Type	Method and Description
protected void	clientInit(WebContext context)
java.lang.String	getFields()
int	getLimit()
java.lang.String	getScope()
java.lang.String	getStateData()
boolean	getUseAppSecretProof()
boolean	isRequiresExtendedToken()
void	setFields(java.lang.String fields)
void	setLimit(int limit)
void	setRequiresExtendedToken(boolean requiresExtendedToken)
void	setScope(java.lang.String scope)
void	setStateData(java.lang.String stateData)
void	setUseAppSecretProof(boolean useSecret)

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

getConfiguration, getKey, getSecret, setConfiguration, setKey, setSecret, toString

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

computeFinalCallbackUrl, defaultLogoutActionBuilder, defaultRedirectActionBuilder, getAjaxRequestResolver, getCallbackUrl, getCallbackUrlResolver, getCredentials, getLogoutAction, getLogoutActionBuilder, getRedirectAction, getRedirectActionBuilder, getUrlResolver, internalInit, isIncludeClientNameInCallbackUrl, redirect, setAjaxRequestResolver, setCallbackUrl, setCallbackUrlResolver, setIncludeClientNameInCallbackUrl, setLogoutActionBuilder, setRedirectActionBuilder, setUrlResolver

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

addAuthorizationGenerator, addAuthorizationGenerators, defaultAuthenticator, defaultCredentialsExtractor, defaultProfileCreator, getAuthenticator, getAuthorizationGenerators, getCredentialsExtractor, getName, getProfileCreator, getUserProfile, notifySessionRenewal, retrieveCredentials, retrieveUserProfile, setAuthenticator, setAuthorizationGenerator, setAuthorizationGenerators, setAuthorizationGenerators, setCredentialsExtractor, setName, setProfileCreator

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

init, reinit

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_FIELDS

public static final java.lang.String DEFAULT_FIELDS

See Also:

Constant Field Values

fields

protected java.lang.String fields

DEFAULT_SCOPE

public static final java.lang.String DEFAULT_SCOPE

See Also:

Constant Field Values

scope

protected java.lang.String scope

limit

protected int limit

requiresExtendedToken

protected boolean requiresExtendedToken

useAppsecretProof

protected boolean useAppsecretProof

Constructor Detail

FacebookClient

public FacebookClient()

FacebookClient

public FacebookClient(java.lang.String key,
                      java.lang.String secret)

Method Detail

clientInit

protected void clientInit(WebContext context)

Overrides:

clientInit in class OAuth20Client<FacebookProfile>

setStateData

public void setStateData(java.lang.String stateData)

getStateData

public java.lang.String getStateData()

setUseAppSecretProof

public void setUseAppSecretProof(boolean useSecret)

getUseAppSecretProof

public boolean getUseAppSecretProof()

getScope

public java.lang.String getScope()

setScope

public void setScope(java.lang.String scope)

getFields

public java.lang.String getFields()

setFields

public void setFields(java.lang.String fields)

getLimit

public int getLimit()

setLimit

public void setLimit(int limit)

isRequiresExtendedToken

public boolean isRequiresExtendedToken()

setRequiresExtendedToken

public void setRequiresExtendedToken(boolean requiresExtendedToken)