Package org.pac4j.oauth.profile.github

Class GitHubProfileDefinition

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.github.GitHubProfileDefinition

public class GitHubProfileDefinition
extends OAuthProfileDefinition

This class is the GitHub profile definition.

Since:

1.1.0

Author:

Jerome Leleu

Field Summary

Fields

Modifier and Type	Field	Description
static final String	AVATAR_URL	Constant AVATAR_URL="avatar_url"
static final String	BIO	Constant BIO="bio"
static final String	BLOG	Constant BLOG="blog"
static final String	COLLABORATORS	Constant COLLABORATORS="collaborators"
static final String	COMPANY	Constant COMPANY="company"
static final String	CREATED_AT	Constant CREATED_AT="created_at"
static final String	DISK_USAGE	Constant DISK_USAGE="disk_usage"
static final String	FOLLOWERS	Constant FOLLOWERS="followers"
static final String	FOLLOWING	Constant FOLLOWING="following"
static final String	GRAVATAR_ID	Constant GRAVATAR_ID="gravatar_id"
static final String	HIREABLE	Constant HIREABLE="hireable"
static final String	HTML_URL	Constant HTML_URL="html_url"
static final String	LOGIN	Constant LOGIN="login"
static final String	NAME	Constant NAME="name"
static final String	OWNED_PRIVATE_REPOS	Constant OWNED_PRIVATE_REPOS="owned_private_repos"
static final String	PLAN	Constant PLAN="plan"
static final String	PRIVATE_GISTS	Constant PRIVATE_GISTS="private_gists"
static final String	PUBLIC_GISTS	Constant PUBLIC_GISTS="public_gists"
static final String	PUBLIC_REPOS	Constant PUBLIC_REPOS="public_repos"
static final String	TOTAL_PRIVATE_REPOS	Constant TOTAL_PRIVATE_REPOS="total_private_repos"
static final String	TYPE	Constant TYPE="type"
static final String	UPDATED_AT	Constant UPDATED_AT="updated_at"
static final String	URL	Constant URL="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

Constructor Summary

Constructors

Constructor	Description
GitHubProfileDefinition()	Constructor for 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.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

TYPE

public static final String TYPE

Constant TYPE="type"

See Also:

• Constant Field Values

BLOG

public static final String BLOG

Constant BLOG="blog"

See Also:

• Constant Field Values

URL

public static final String URL

Constant URL="url"

See Also:

• Constant Field Values

PUBLIC_GISTS

public static final String PUBLIC_GISTS

Constant PUBLIC_GISTS="public_gists"

See Also:

• Constant Field Values

FOLLOWING

public static final String FOLLOWING

Constant FOLLOWING="following"

See Also:

• Constant Field Values

PRIVATE_GISTS

public static final String PRIVATE_GISTS

Constant PRIVATE_GISTS="private_gists"

See Also:

• Constant Field Values

PUBLIC_REPOS

public static final String PUBLIC_REPOS

Constant PUBLIC_REPOS="public_repos"

See Also:

• Constant Field Values

GRAVATAR_ID

public static final String GRAVATAR_ID

Constant GRAVATAR_ID="gravatar_id"

See Also:

• Constant Field Values

AVATAR_URL

public static final String AVATAR_URL

Constant AVATAR_URL="avatar_url"

See Also:

• Constant Field Values

FOLLOWERS

public static final String FOLLOWERS

Constant FOLLOWERS="followers"

See Also:

• Constant Field Values

LOGIN

public static final String LOGIN

Constant LOGIN="login"

See Also:

• Constant Field Values

COMPANY

public static final String COMPANY

Constant COMPANY="company"

See Also:

• Constant Field Values

HIREABLE

public static final String HIREABLE

Constant HIREABLE="hireable"

See Also:

• Constant Field Values

COLLABORATORS

public static final String COLLABORATORS

Constant COLLABORATORS="collaborators"

See Also:

• Constant Field Values

HTML_URL

public static final String HTML_URL

Constant HTML_URL="html_url"

See Also:

• Constant Field Values

BIO

public static final String BIO

Constant BIO="bio"

See Also:

• Constant Field Values

TOTAL_PRIVATE_REPOS

public static final String TOTAL_PRIVATE_REPOS

Constant TOTAL_PRIVATE_REPOS="total_private_repos"

See Also:

• Constant Field Values

CREATED_AT

public static final String CREATED_AT

Constant CREATED_AT="created_at"

See Also:

• Constant Field Values

UPDATED_AT

public static final String UPDATED_AT

Constant UPDATED_AT="updated_at"

See Also:

• Constant Field Values

NAME

public static final String NAME

Constant NAME="name"

See Also:

• Constant Field Values

DISK_USAGE

public static final String DISK_USAGE

Constant DISK_USAGE="disk_usage"

See Also:

• Constant Field Values

PLAN

public static final String PLAN

Constant PLAN="plan"

See Also:

• Constant Field Values

OWNED_PRIVATE_REPOS

public static final String OWNED_PRIVATE_REPOS

Constant OWNED_PRIVATE_REPOS="owned_private_repos"

See Also:

• Constant Field Values

Constructor Details

GitHubProfileDefinition

public GitHubProfileDefinition()

Constructor for GitHubProfileDefinition.

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 GitHubProfile 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