org.pac4j.oauth.profile.foursquare

Class FoursquareProfileDefinition

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,OAuth20Configuration>

org.pac4j.oauth.profile.definition.OAuth20ProfileDefinition<FoursquareProfile>

org.pac4j.oauth.profile.foursquare.FoursquareProfileDefinition

public class FoursquareProfileDefinition
extends OAuth20ProfileDefinition<FoursquareProfile>

This class is the Foursquare profile definition.

Since:

1.5.0

Author:

Alexey Ogarkov

Field Summary

Fields

Modifier and Type	Field and Description
static String	BIO
static String	CONTACT
static String	FIRENDS
static String	FIRST_NAME
static String	HOME_CITY
static String	LAST_NAME
static String	PHOTO

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

DISPLAY_NAME, EMAIL, FAMILY_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
FoursquareProfileDefinition()

Method Summary

Modifier and Type	Method and Description
FoursquareProfile	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, OAuth20Configuration 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, getSecondaryAttributes, newProfile, primary, secondary, setProfileFactory

Methods inherited from class java.lang.Object

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

Field Detail

FIRST_NAME

public static final String FIRST_NAME

See Also:

Constant Field Values

LAST_NAME

public static final String LAST_NAME

See Also:

Constant Field Values

PHOTO

public static final String PHOTO

See Also:

Constant Field Values

FIRENDS

public static final String FIRENDS

See Also:

Constant Field Values

HOME_CITY

public static final String HOME_CITY

See Also:

Constant Field Values

CONTACT

public static final String CONTACT

See Also:

Constant Field Values

BIO

public static final String BIO

See Also:

Constant Field Values

Constructor Detail

FoursquareProfileDefinition

public FoursquareProfileDefinition()

Method Detail

getProfileUrl

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

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

extractUserProfile

public FoursquareProfile extractUserProfile(String body)
                                     throws HttpAction

Description copied from class: OAuthProfileDefinition

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

Specified by:

extractUserProfile in class OAuthProfileDefinition<FoursquareProfile,com.github.scribejava.core.model.OAuth2AccessToken,OAuth20Configuration>

Parameters:

body - the response body

Returns:

the returned profile

Throws:

HttpAction - whether an extra HTTP action is required