Package org.pac4j.oauth.profile.cronofy

Class CronofyProfileDefinition

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.cronofy.CronofyProfileDefinition
public class CronofyProfileDefinition extends OAuthProfileDefinition
This class is the Cronofy profile definition.
Since:
5.3.1
Author:
Jerome Leleu

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final String
    ACCOUNT_ID
    Constant ACCOUNT_ID="account_id"
    static final String
    PROFILE_ID
    Constant PROFILE_ID="profile_id"
    static final String
    PROFILE_NAME
    Constant PROFILE_NAME="profile_name"
    static final String
    PROVIDER_NAME
    Constant PROVIDER_NAME="provider_name"
    static final String
    PROVIDER_SERVICE
    Constant PROVIDER_SERVICE="provider_service"
    static final String
    SUB
    Constant SUB="sub"

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

    DISPLAY_NAME, EMAIL, FAMILY_NAME, FIRST_NAME, GENDER, LOCALE, LOCATION, PICTURE_URL, PROFILE_URL

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

    logger

  • Constructor Summary

    Constructors
    Constructor
    Description
    CronofyProfileDefinition()
    Constructor for CronofyProfileDefinition.

  • Method Summary

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

    • CronofyProfileDefinition

      public CronofyProfileDefinition()

      Constructor for CronofyProfileDefinition.

  • 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 CronofyProfile 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