Package org.pac4j.oauth.profile.twitter

Class TwitterProfileDefinition

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.OAuth1Token,OAuth10Configuration>

org.pac4j.oauth.profile.definition.OAuth10ProfileDefinition<TwitterProfile>

org.pac4j.oauth.profile.twitter.TwitterProfileDefinition

public class TwitterProfileDefinition
extends OAuth10ProfileDefinition<TwitterProfile>

This class is the Twitter profile definition.

Since:

1.1.0

Author:

Jerome Leleu

Field Summary

Fields

Modifier and Type	Field	Description
static String	CONTRIBUTORS_ENABLED
static String	CREATED_AT
static String	DEFAULT_PROFILE
static String	DEFAULT_PROFILE_IMAGE
static String	DESCRIPTION
static String	EMAIL
static String	FAVOURITES_COUNT
static String	FOLLOW_REQUEST_SENT
static String	FOLLOWERS_COUNT
static String	FOLLOWING
static String	FRIENDS_COUNT
static String	GEO_ENABLED
static String	IS_TRANSLATOR
static String	LANG
static String	LISTED_COUNT
static String	NAME
static String	NOTIFICATIONS
static String	PROFILE_BACKGROUND_COLOR
static String	PROFILE_BACKGROUND_IMAGE_URL
static String	PROFILE_BACKGROUND_IMAGE_URL_HTTPS
static String	PROFILE_BACKGROUND_TILE
static String	PROFILE_IMAGE_URL
static String	PROFILE_IMAGE_URL_HTTPS
static String	PROFILE_LINK_COLOR
static String	PROFILE_SIDEBAR_BORDER_COLOR
static String	PROFILE_SIDEBAR_FILL_COLOR
static String	PROFILE_TEXT_COLOR
static String	PROFILE_USE_BACKGROUND_IMAGE
static String	PROTECTED
static String	SCREEN_NAME
static String	SHOW_ALL_INLINE_MEDIA
static String	STATUSES_COUNT
static String	TIME_ZONE
static String	URL
static String	UTC_OFFSET
static String	VERIFIED

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

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

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

logger, newProfile

Constructor Summary

Constructors

Constructor	Description
TwitterProfileDefinition()
TwitterProfileDefinition(boolean includeEmail)

Method Summary

Modifier and Type	Method	Description
TwitterProfile	extractUserProfile(String body)	Extract the user profile from the response (JSON, XML...) of the profile url.
String	getProfileUrl(com.github.scribejava.core.model.OAuth1Token accessToken, OAuth10Configuration 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, getPrimaryAttributes, getProfileId, getSecondaryAttributes, newProfile, primary, secondary, setProfileFactory, setProfileId

Methods inherited from class java.lang.Object

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

Field Detail

CONTRIBUTORS_ENABLED

public static final String CONTRIBUTORS_ENABLED

See Also:

Constant Field Values

CREATED_AT

public static final String CREATED_AT

See Also:

Constant Field Values

DEFAULT_PROFILE

public static final String DEFAULT_PROFILE

See Also:

Constant Field Values

DEFAULT_PROFILE_IMAGE

public static final String DEFAULT_PROFILE_IMAGE

See Also:

Constant Field Values

DESCRIPTION

public static final String DESCRIPTION

See Also:

Constant Field Values

EMAIL

public static final String EMAIL

See Also:

Constant Field Values

FAVOURITES_COUNT

public static final String FAVOURITES_COUNT

See Also:

Constant Field Values

FOLLOW_REQUEST_SENT

public static final String FOLLOW_REQUEST_SENT

See Also:

Constant Field Values

FOLLOWERS_COUNT

public static final String FOLLOWERS_COUNT

See Also:

Constant Field Values

FOLLOWING

public static final String FOLLOWING

See Also:

Constant Field Values

FRIENDS_COUNT

public static final String FRIENDS_COUNT

See Also:

Constant Field Values

GEO_ENABLED

public static final String GEO_ENABLED

See Also:

Constant Field Values

IS_TRANSLATOR

public static final String IS_TRANSLATOR

See Also:

Constant Field Values

LANG

public static final String LANG

See Also:

Constant Field Values

LISTED_COUNT

public static final String LISTED_COUNT

See Also:

Constant Field Values

NAME

public static final String NAME

See Also:

Constant Field Values

NOTIFICATIONS

public static final String NOTIFICATIONS

See Also:

Constant Field Values

PROFILE_BACKGROUND_COLOR

public static final String PROFILE_BACKGROUND_COLOR

See Also:

Constant Field Values

PROFILE_BACKGROUND_IMAGE_URL

public static final String PROFILE_BACKGROUND_IMAGE_URL

See Also:

Constant Field Values

PROFILE_BACKGROUND_IMAGE_URL_HTTPS

public static final String PROFILE_BACKGROUND_IMAGE_URL_HTTPS

See Also:

Constant Field Values

PROFILE_BACKGROUND_TILE

public static final String PROFILE_BACKGROUND_TILE

See Also:

Constant Field Values

PROFILE_IMAGE_URL

public static final String PROFILE_IMAGE_URL

See Also:

Constant Field Values

PROFILE_IMAGE_URL_HTTPS

public static final String PROFILE_IMAGE_URL_HTTPS

See Also:

Constant Field Values

PROFILE_LINK_COLOR

public static final String PROFILE_LINK_COLOR

See Also:

Constant Field Values

PROFILE_SIDEBAR_BORDER_COLOR

public static final String PROFILE_SIDEBAR_BORDER_COLOR

See Also:

Constant Field Values

PROFILE_SIDEBAR_FILL_COLOR

public static final String PROFILE_SIDEBAR_FILL_COLOR

See Also:

Constant Field Values

PROFILE_TEXT_COLOR

public static final String PROFILE_TEXT_COLOR

See Also:

Constant Field Values

PROFILE_USE_BACKGROUND_IMAGE

public static final String PROFILE_USE_BACKGROUND_IMAGE

See Also:

Constant Field Values

PROTECTED

public static final String PROTECTED

See Also:

Constant Field Values

SCREEN_NAME

public static final String SCREEN_NAME

See Also:

Constant Field Values

SHOW_ALL_INLINE_MEDIA

public static final String SHOW_ALL_INLINE_MEDIA

See Also:

Constant Field Values

STATUSES_COUNT

public static final String STATUSES_COUNT

See Also:

Constant Field Values

TIME_ZONE

public static final String TIME_ZONE

See Also:

Constant Field Values

URL

public static final String URL

See Also:

Constant Field Values

UTC_OFFSET

public static final String UTC_OFFSET

See Also:

Constant Field Values

VERIFIED

public static final String VERIFIED

See Also:

Constant Field Values

Constructor Detail

TwitterProfileDefinition

public TwitterProfileDefinition()

TwitterProfileDefinition

public TwitterProfileDefinition(boolean includeEmail)

Method Detail

getProfileUrl

public String getProfileUrl(com.github.scribejava.core.model.OAuth1Token accessToken,
                            OAuth10Configuration 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<TwitterProfile,com.github.scribejava.core.model.OAuth1Token,OAuth10Configuration>

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)

Description copied from class: OAuthProfileDefinition

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

Specified by:

extractUserProfile in class OAuthProfileDefinition<TwitterProfile,com.github.scribejava.core.model.OAuth1Token,OAuth10Configuration>

Parameters:

body - the response body

Returns:

the returned profile