org.pac4j.oauth.client

Class GitHubClient

java.lang.Object

org.pac4j.core.util.InitializableWebObject

org.pac4j.core.client.BaseClient<C,U>

org.pac4j.core.client.IndirectClient<OAuth20Credentials,U>

org.pac4j.oauth.client.OAuth20Client<GitHubProfile>

org.pac4j.oauth.client.GitHubClient

All Implemented Interfaces:

Client<OAuth20Credentials,GitHubProfile>

public class GitHubClient
extends OAuth20Client<GitHubProfile>

This class is the OAuth client to authenticate users in GitHub.

The scope can be defined to require specific permissions from the user by using the setScope(String) method. By default, the scope is: user.

It returns a GitHubProfile.

More information at http://developer.github.com/v3/users/

Since:

1.0.0

Author:

Jerome Leleu

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	DEFAULT_SCOPE
protected java.lang.String	scope

Fields inherited from class org.pac4j.oauth.client.OAuth20Client

configuration

Fields inherited from class org.pac4j.core.client.IndirectClient

ATTEMPTED_AUTHENTICATION_SUFFIX, callbackUrl, urlResolver

Fields inherited from class org.pac4j.core.client.BaseClient

logger

Constructor Summary

Constructors

Constructor and Description
GitHubClient()
GitHubClient(java.lang.String key, java.lang.String secret)

Method Summary

Modifier and Type	Method and Description
protected void	clientInit(WebContext context)
java.lang.String	getScope()
void	setScope(java.lang.String scope)

Methods inherited from class org.pac4j.oauth.client.OAuth20Client

getConfiguration, getKey, getSecret, setConfiguration, setKey, setSecret, toString

Methods inherited from class org.pac4j.core.client.IndirectClient

computeFinalCallbackUrl, defaultLogoutActionBuilder, defaultRedirectActionBuilder, getAjaxRequestResolver, getCallbackUrl, getCallbackUrlResolver, getCredentials, getLogoutAction, getLogoutActionBuilder, getRedirectAction, getRedirectActionBuilder, getUrlResolver, internalInit, isIncludeClientNameInCallbackUrl, redirect, setAjaxRequestResolver, setCallbackUrl, setCallbackUrlResolver, setIncludeClientNameInCallbackUrl, setLogoutActionBuilder, setRedirectActionBuilder, setUrlResolver

Methods inherited from class org.pac4j.core.client.BaseClient

addAuthorizationGenerator, addAuthorizationGenerators, defaultAuthenticator, defaultCredentialsExtractor, defaultProfileCreator, getAuthenticator, getAuthorizationGenerators, getCredentialsExtractor, getName, getProfileCreator, getUserProfile, notifySessionRenewal, retrieveCredentials, retrieveUserProfile, setAuthenticator, setAuthorizationGenerator, setAuthorizationGenerators, setAuthorizationGenerators, setCredentialsExtractor, setName, setProfileCreator

Methods inherited from class org.pac4j.core.util.InitializableWebObject

init, reinit

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_SCOPE

public static final java.lang.String DEFAULT_SCOPE

See Also:

Constant Field Values

scope

protected java.lang.String scope

Constructor Detail

GitHubClient

public GitHubClient()

GitHubClient

public GitHubClient(java.lang.String key,
                    java.lang.String secret)

Method Detail

clientInit

protected void clientInit(WebContext context)

Overrides:

clientInit in class OAuth20Client<GitHubProfile>

getScope

public java.lang.String getScope()

setScope

public void setScope(java.lang.String scope)