Package org.pac4j.oauth.profile.github

Class GitHubProfileDefinition

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.OAuth2AccessToken,C>

org.pac4j.oauth.profile.definition.OAuth20ProfileDefinition<GitHubProfile,OAuth20Configuration>

org.pac4j.oauth.profile.github.GitHubProfileDefinition

public class GitHubProfileDefinition
extends OAuth20ProfileDefinition<GitHubProfile,OAuth20Configuration>

This class is the GitHub profile definition.

Since:

1.1.0

Author:

Jerome Leleu

Field Summary

Fields

Modifier and Type	Field	Description
static String	AVATAR_URL
static String	BIO
static String	BLOG
static String	COLLABORATORS
static String	COMPANY
static String	CREATED_AT
static String	DISK_USAGE
static String	FOLLOWERS
static String	FOLLOWING
static String	GRAVATAR_ID
static String	HIREABLE
static String	HTML_URL
static String	LOGIN
static String	NAME
static String	OWNED_PRIVATE_REPOS
static String	PLAN
static String	PRIVATE_GISTS
static String	PUBLIC_GISTS
static String	PUBLIC_REPOS
static String	TOTAL_PRIVATE_REPOS
static String	TYPE
static String	UPDATED_AT
static String	URL

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, newProfile

Constructor Summary

Constructors

Constructor	Description
GitHubProfileDefinition()

Method Summary

Modifier and Type	Method	Description
GitHubProfile	extractUserProfile(String body)	Extract the user profile from the response (JSON, XML...) of the profile url.
String	getProfileUrl(com.github.scribejava.core.model.OAuth2AccessToken accessToken, OAuth20Configuration 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

TYPE

public static final String TYPE

See Also:

Constant Field Values

BLOG

public static final String BLOG

See Also:

Constant Field Values

URL

public static final String URL

See Also:

Constant Field Values

PUBLIC_GISTS

public static final String PUBLIC_GISTS

See Also:

Constant Field Values

FOLLOWING

public static final String FOLLOWING

See Also:

Constant Field Values

PRIVATE_GISTS

public static final String PRIVATE_GISTS

See Also:

Constant Field Values

PUBLIC_REPOS

public static final String PUBLIC_REPOS

See Also:

Constant Field Values

GRAVATAR_ID

public static final String GRAVATAR_ID

See Also:

Constant Field Values

AVATAR_URL

public static final String AVATAR_URL

See Also:

Constant Field Values

FOLLOWERS

public static final String FOLLOWERS

See Also:

Constant Field Values

LOGIN

public static final String LOGIN

See Also:

Constant Field Values

COMPANY

public static final String COMPANY

See Also:

Constant Field Values

HIREABLE

public static final String HIREABLE

See Also:

Constant Field Values

COLLABORATORS

public static final String COLLABORATORS

See Also:

Constant Field Values

HTML_URL

public static final String HTML_URL

See Also:

Constant Field Values

BIO

public static final String BIO

See Also:

Constant Field Values

TOTAL_PRIVATE_REPOS

public static final String TOTAL_PRIVATE_REPOS

See Also:

Constant Field Values

CREATED_AT

public static final String CREATED_AT

See Also:

Constant Field Values

UPDATED_AT

public static final String UPDATED_AT

See Also:

Constant Field Values

NAME

public static final String NAME

See Also:

Constant Field Values

DISK_USAGE

public static final String DISK_USAGE

See Also:

Constant Field Values

PLAN

public static final String PLAN

See Also:

Constant Field Values

OWNED_PRIVATE_REPOS

public static final String OWNED_PRIVATE_REPOS

See Also:

Constant Field Values

Constructor Detail

GitHubProfileDefinition

public GitHubProfileDefinition()

Method Detail

getProfileUrl

public String getProfileUrl(com.github.scribejava.core.model.OAuth2AccessToken accessToken,
                            OAuth20Configuration 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<GitHubProfile,com.github.scribejava.core.model.OAuth2AccessToken,OAuth20Configuration>

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 GitHubProfile 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<GitHubProfile,com.github.scribejava.core.model.OAuth2AccessToken,OAuth20Configuration>

Parameters:

body - the response body

Returns:

the returned profile