Package org.pac4j.oauth.client
Class GitHubClient
- java.lang.Object
-
- org.pac4j.core.util.InitializableObject
-
- org.pac4j.core.client.BaseClient<C>
-
- org.pac4j.core.client.IndirectClient<OAuth20Credentials>
-
- org.pac4j.oauth.client.OAuth20Client
-
- org.pac4j.oauth.client.GitHubClient
-
- All Implemented Interfaces:
Client<OAuth20Credentials>
public class GitHubClient extends OAuth20Client
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 Description static String
DEFAULT_SCOPE
-
Fields inherited from class org.pac4j.oauth.client.OAuth20Client
configuration
-
Fields inherited from class org.pac4j.core.client.IndirectClient
ATTEMPTED_AUTHENTICATION_SUFFIX, callbackUrl, callbackUrlResolver, urlResolver
-
Fields inherited from class org.pac4j.core.client.BaseClient
logger
-
-
Constructor Summary
Constructors Constructor Description GitHubClient()
GitHubClient(String key, String secret)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description protected void
clientInit()
String
getScope()
void
setScope(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, defaultRedirectionActionBuilder, getAjaxRequestResolver, getCallbackUrl, getCallbackUrlResolver, getCodeVerifierSessionAttributeName, getCredentials, getLogoutAction, getLogoutActionBuilder, getNonceSessionAttributeName, getRedirectionAction, getRedirectionActionBuilder, getStateSessionAttributeName, getUrlResolver, internalInit, newDefaultCallbackUrlResolver, setAjaxRequestResolver, setCallbackUrl, setCallbackUrlResolver, setLogoutActionBuilder, setRedirectionActionBuilder, setUrlResolver
-
Methods inherited from class org.pac4j.core.client.BaseClient
addAuthorizationGenerator, addAuthorizationGenerators, defaultAuthenticator, defaultCredentialsExtractor, defaultProfileCreator, getAuthenticator, getAuthorizationGenerators, getCredentialsExtractor, getCustomProperties, getName, getProfileCreator, getProfileFactoryWhenNotAuthenticated, getUserProfile, notifySessionRenewal, renewUserProfile, retrieveCredentials, retrieveUserProfile, setAuthenticator, setAuthorizationGenerator, setAuthorizationGenerators, setAuthorizationGenerators, setCredentialsExtractor, setCustomProperties, setName, setProfileCreator, setProfileFactoryWhenNotAuthenticated
-
Methods inherited from class org.pac4j.core.util.InitializableObject
init, isInitialized
-
-
-
-
Field Detail
-
DEFAULT_SCOPE
public static final String DEFAULT_SCOPE
- See Also:
- Constant Field Values
-
-
Method Detail
-
clientInit
protected void clientInit()
- Overrides:
clientInit
in classOAuth20Client
-
getScope
public String getScope()
-
setScope
public void setScope(String scope)
-
-