Package org.pac4j.oauth.profile.foursquare

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
public class FoursquareProfileDefinition extends OAuthProfileDefinition
This class is the Foursquare profile definition.
Since:
1.5.0
Author:
Alexey Ogarkov

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final String
    BIO
    Constant BIO="bio"
    static final String
    CONTACT
    Constant CONTACT="contact"
    static final String
    FIRENDS
    Constant FIRENDS="friends"
    static final String
    FIRST_NAME
    Constant FIRST_NAME="firstName"
    static final String
    HOME_CITY
    Constant HOME_CITY="homeCity"
    static final String
    LAST_NAME
    Constant LAST_NAME="lastName"
    static final String
    PHOTO
    Constant PHOTO="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

    Constructors
    Constructor
    Description
    FoursquareProfileDefinition()
    Constructor for FoursquareProfileDefinition.

  • Method Summary

    Modifier and Type
    Method
    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.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

    Methods inherited from class java.lang.Object

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

  • Field Details

  • 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 class OAuthProfileDefinition
      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)
      Extract the user profile from the response (JSON, XML...) of the profile url.
      Specified by:
      extractUserProfile in class OAuthProfileDefinition
      Parameters:
      body - the response body
      Returns:
      the returned profile