org.pac4j.oauth.profile.github

Class GitHubProfile

java.lang.Object

org.pac4j.core.profile.UserProfile

org.pac4j.core.profile.CommonProfile

org.pac4j.oauth.profile.OAuth20Profile

org.pac4j.oauth.profile.github.GitHubProfile

All Implemented Interfaces:

Externalizable, Serializable

public class GitHubProfile
extends OAuth20Profile

This class is the user profile for GitHub with appropriate getters.

It is returned by the GitHubClient.

Since:

1.1.0

Author:

Jerome Leleu

See Also:

Serialized Form

Field Summary

Fields inherited from class org.pac4j.core.profile.UserProfile

logger, SEPARATOR

Constructor Summary

Constructors

Constructor and Description
GitHubProfile()

Method Summary

Modifier and Type	Method and Description
String	getBio()
String	getBlog()
Integer	getCollaborators()
String	getCompany()
Date	getCreatedAt()
Integer	getDiskUsage()
String	getDisplayName() Return the displayed name of the user.
Integer	getFollowers()
Integer	getFollowing()
String	getGravatarId()
Boolean	getHireable()
Integer	getOwnedPrivateRepos()
URI	getPictureUrl() Return the url of the picture of the user.
GitHubPlan	getPlan()
Integer	getPrivateGists()
URI	getProfileUrl() Return the url of the profile of the user.
Integer	getPublicGists()
Integer	getPublicRepos()
Integer	getTotalPrivateRepos()
String	getType()
Date	getUpdatedAt()
String	getUrl()
String	getUsername() Return the username of the user.

Methods inherited from class org.pac4j.oauth.profile.OAuth20Profile

clearSensitiveData, getAccessToken, setAccessToken

Methods inherited from class org.pac4j.core.profile.CommonProfile

getEmail, getFamilyName, getFirstName, getGender, getLocale, getLocation

Methods inherited from class org.pac4j.core.profile.UserProfile

addAttribute, addAttributes, addPermission, addPermissions, addRole, addRoles, addRoles, build, containsAttribute, getAttribute, getAttribute, getAttributes, getClientName, getId, getLinkedId, getPermissions, getRoles, getTypedId, isRemembered, readExternal, removeAttribute, setClientName, setId, setLinkedId, setRemembered, toString, writeExternal

Methods inherited from class java.lang.Object

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

Constructor Detail

GitHubProfile

public GitHubProfile()

Method Detail

getDisplayName

public String getDisplayName()

Description copied from class: CommonProfile

Return the displayed name of the user. It can be the username or the first and last names (separated by a space).

Overrides:

getDisplayName in class CommonProfile

Returns:

the displayed name of the user

getUsername

public String getUsername()

Description copied from class: CommonProfile

Return the username of the user. It can be a login or a specific username.

Overrides:

getUsername in class CommonProfile

Returns:

the username of the user

getPictureUrl

public URI getPictureUrl()

Description copied from class: CommonProfile

Return the url of the picture of the user.

Overrides:

getPictureUrl in class CommonProfile

Returns:

the url of the picture of the user.

getProfileUrl

public URI getProfileUrl()

Description copied from class: CommonProfile

Return the url of the profile of the user.

Overrides:

getProfileUrl in class CommonProfile

Returns:

the url of the profile of the user.

getCompany

public String getCompany()

getFollowing

public Integer getFollowing()

getBlog

public String getBlog()

getPublicRepos

public Integer getPublicRepos()

getPublicGists

public Integer getPublicGists()

getDiskUsage

public Integer getDiskUsage()

getCollaborators

public Integer getCollaborators()

getPlan

public GitHubPlan getPlan()

getOwnedPrivateRepos

public Integer getOwnedPrivateRepos()

getTotalPrivateRepos

public Integer getTotalPrivateRepos()

getPrivateGists

public Integer getPrivateGists()

getFollowers

public Integer getFollowers()

getCreatedAt

public Date getCreatedAt()

getUpdatedAt

public Date getUpdatedAt()

getType

public String getType()

getGravatarId

public String getGravatarId()

getUrl

public String getUrl()

getHireable

public Boolean getHireable()

getBio

public String getBio()