Class FoursquareProfileDefinition
java.lang.Object
org.pac4j.core.profile.definition.ProfileDefinition
org.pac4j.core.profile.definition.CommonProfileDefinition
org.pac4j.oauth.profile.definition.OAuthProfileDefinition
org.pac4j.oauth.profile.foursquare.FoursquareProfileDefinition
This class is the Foursquare profile definition.
- Since:
- 1.5.0
- Author:
- Alexey Ogarkov
-
Field Summary
Modifier and TypeFieldDescriptionstatic final String
ConstantBIO="bio"
static final String
ConstantCONTACT="contact"
static final String
ConstantFIRENDS="friends"
static final String
ConstantFIRST_NAME="firstName"
static final String
ConstantHOME_CITY="homeCity"
static final String
ConstantLAST_NAME="lastName"
static final String
ConstantPHOTO="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
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionextractUserProfile
(String body) Extract the user profile from the response (JSON, XML...) of the profile url.getProfileUrl
(com.github.scribejava.core.model.Token accessToken, OAuthConfiguration 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, getLogger, getParameter, getPrimaryAttributes, getProfileFactory, getProfileId, getSecondaryAttributes, isRestoreProfileFromTypedId, newProfile, primary, secondary, setProfileFactory, setProfileId, setRestoreProfileFromTypedId
-
Field Details
-
FIRST_NAME
ConstantFIRST_NAME="firstName"
- See Also:
-
LAST_NAME
ConstantLAST_NAME="lastName"
- See Also:
-
PHOTO
ConstantPHOTO="photo"
- See Also:
-
FIRENDS
ConstantFIRENDS="friends"
- See Also:
-
HOME_CITY
ConstantHOME_CITY="homeCity"
- See Also:
-
CONTACT
ConstantCONTACT="contact"
- See Also:
-
BIO
ConstantBIO="bio"
- See Also:
-
-
Constructor Details
-
FoursquareProfileDefinition
public FoursquareProfileDefinition()Constructor for FoursquareProfileDefinition.
-
-
Method Details
-
getProfileUrl
public String getProfileUrl(com.github.scribejava.core.model.Token accessToken, OAuthConfiguration configuration) Retrieve the url of the profile of the authenticated user for the provider.- Specified by:
getProfileUrl
in classOAuthProfileDefinition
- Parameters:
accessToken
- only used when constructing dynamic urls from data in the tokenconfiguration
- the current configuration- Returns:
- the url of the user profile given by the provider
-
extractUserProfile
Extract the user profile from the response (JSON, XML...) of the profile url.- Specified by:
extractUserProfile
in classOAuthProfileDefinition
- Parameters:
body
- the response body- Returns:
- the returned profile
-