Package org.pac4j.oauth.profile.twitter

Class TwitterProfileDefinition

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.twitter.TwitterProfileDefinition
public class TwitterProfileDefinition extends OAuthProfileDefinition
This class is the Twitter profile definition.
Since:
1.1.0
Author:
Jerome Leleu

  • Field Details

    • CONTRIBUTORS_ENABLED

      public static final String CONTRIBUTORS_ENABLED
      Constant CONTRIBUTORS_ENABLED="contributors_enabled"
      See Also:

    • CREATED_AT

      public static final String CREATED_AT
      Constant CREATED_AT="created_at"
      See Also:

    • DEFAULT_PROFILE

      public static final String DEFAULT_PROFILE
      Constant DEFAULT_PROFILE="default_profile"
      See Also:

    • DEFAULT_PROFILE_IMAGE

      public static final String DEFAULT_PROFILE_IMAGE
      Constant DEFAULT_PROFILE_IMAGE="default_profile_image"
      See Also:

    • DESCRIPTION

      public static final String DESCRIPTION
      Constant DESCRIPTION="description"
      See Also:

    • EMAIL

      public static final String EMAIL
      Constant EMAIL="email"
      See Also:

    • FAVOURITES_COUNT

      public static final String FAVOURITES_COUNT
      Constant FAVOURITES_COUNT="favourites_count"
      See Also:

    • FOLLOW_REQUEST_SENT

      public static final String FOLLOW_REQUEST_SENT
      Constant FOLLOW_REQUEST_SENT="follow_request_sent"
      See Also:

    • FOLLOWERS_COUNT

      public static final String FOLLOWERS_COUNT
      Constant FOLLOWERS_COUNT="followers_count"
      See Also:

    • FOLLOWING

      public static final String FOLLOWING
      Constant FOLLOWING="following"
      See Also:

    • FRIENDS_COUNT

      public static final String FRIENDS_COUNT
      Constant FRIENDS_COUNT="friends_count"
      See Also:

    • GEO_ENABLED

      public static final String GEO_ENABLED
      Constant GEO_ENABLED="geo_enabled"
      See Also:

    • IS_TRANSLATOR

      public static final String IS_TRANSLATOR
      Constant IS_TRANSLATOR="is_translator"
      See Also:

    • LANG

      public static final String LANG
      Constant LANG="lang"
      See Also:

    • LISTED_COUNT

      public static final String LISTED_COUNT
      Constant LISTED_COUNT="listed_count"
      See Also:

    • NAME

      public static final String NAME
      Constant NAME="name"
      See Also:

    • NOTIFICATIONS

      public static final String NOTIFICATIONS
      Constant NOTIFICATIONS="notifications"
      See Also:

    • PROFILE_BACKGROUND_COLOR

      public static final String PROFILE_BACKGROUND_COLOR
      Constant PROFILE_BACKGROUND_COLOR="profile_background_color"
      See Also:

    • PROFILE_BACKGROUND_IMAGE_URL

      public static final String PROFILE_BACKGROUND_IMAGE_URL
      Constant PROFILE_BACKGROUND_IMAGE_URL="profile_background_image_url"
      See Also:

    • PROFILE_BACKGROUND_IMAGE_URL_HTTPS

      public static final String PROFILE_BACKGROUND_IMAGE_URL_HTTPS
      Constant PROFILE_BACKGROUND_IMAGE_URL_HTTPS="profile_background_image_url_https"
      See Also:

    • PROFILE_BACKGROUND_TILE

      public static final String PROFILE_BACKGROUND_TILE
      Constant PROFILE_BACKGROUND_TILE="profile_background_tile"
      See Also:

    • PROFILE_IMAGE_URL

      public static final String PROFILE_IMAGE_URL
      Constant PROFILE_IMAGE_URL="profile_image_url"
      See Also:

    • PROFILE_IMAGE_URL_HTTPS

      public static final String PROFILE_IMAGE_URL_HTTPS
      Constant PROFILE_IMAGE_URL_HTTPS="profile_image_url_https"
      See Also:

    • PROFILE_SIDEBAR_BORDER_COLOR

      public static final String PROFILE_SIDEBAR_BORDER_COLOR
      Constant PROFILE_SIDEBAR_BORDER_COLOR="profile_sidebar_border_color"
      See Also:

    • PROFILE_SIDEBAR_FILL_COLOR

      public static final String PROFILE_SIDEBAR_FILL_COLOR
      Constant PROFILE_SIDEBAR_FILL_COLOR="profile_sidebar_fill_color"
      See Also:

    • PROFILE_TEXT_COLOR

      public static final String PROFILE_TEXT_COLOR
      Constant PROFILE_TEXT_COLOR="profile_text_color"
      See Also:

    • PROFILE_USE_BACKGROUND_IMAGE

      public static final String PROFILE_USE_BACKGROUND_IMAGE
      Constant PROFILE_USE_BACKGROUND_IMAGE="profile_use_background_image"
      See Also:

    • PROTECTED

      public static final String PROTECTED
      Constant PROTECTED="protected"
      See Also:

    • SCREEN_NAME

      public static final String SCREEN_NAME
      Constant SCREEN_NAME="screen_name"
      See Also:

    • SHOW_ALL_INLINE_MEDIA

      public static final String SHOW_ALL_INLINE_MEDIA
      Constant SHOW_ALL_INLINE_MEDIA="show_all_inline_media"
      See Also:

    • STATUSES_COUNT

      public static final String STATUSES_COUNT
      Constant STATUSES_COUNT="statuses_count"
      See Also:

    • TIME_ZONE

      public static final String TIME_ZONE
      Constant TIME_ZONE="time_zone"
      See Also:

    • URL

      public static final String URL
      Constant URL="url"
      See Also:

    • UTC_OFFSET

      public static final String UTC_OFFSET
      Constant UTC_OFFSET="utc_offset"
      See Also:

    • VERIFIED

      public static final String VERIFIED
      Constant VERIFIED="verified"
      See Also:

  • Constructor Details

    • TwitterProfileDefinition

      public TwitterProfileDefinition()

      Constructor for TwitterProfileDefinition.

    • TwitterProfileDefinition

      public TwitterProfileDefinition(boolean includeEmail)

      Constructor for TwitterProfileDefinition.

      Parameters:
      includeEmail - a boolean

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