Package org.pac4j.oauth.client
Class GitHubClient
- java.lang.Object
-
- org.pac4j.core.util.InitializableObject
-
- org.pac4j.core.client.BaseClient
-
- org.pac4j.core.client.IndirectClient
-
- org.pac4j.oauth.client.OAuth20Client
-
- org.pac4j.oauth.client.GitHubClient
-
- All Implemented Interfaces:
org.pac4j.core.client.Client
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 java.lang.String
DEFAULT_SCOPE
-
Fields inherited from class org.pac4j.oauth.client.OAuth20Client
configuration
-
-
Constructor Summary
Constructors Constructor Description GitHubClient()
GitHubClient(java.lang.String key, java.lang.String secret)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description java.lang.String
getScope()
protected void
internalInit(boolean forceReinit)
void
setScope(java.lang.String scope)
-
Methods inherited from class org.pac4j.oauth.client.OAuth20Client
beforeInternalInit, getConfiguration, getKey, getSecret, setConfiguration, setKey, setSecret, toString
-
Methods inherited from class org.pac4j.core.client.IndirectClient
afterInternalInit, computeFinalCallbackUrl, defaultLogoutActionBuilder, defaultRedirectionActionBuilder, getAjaxRequestResolver, getCallbackUrl, getCallbackUrlResolver, getCodeVerifierSessionAttributeName, getCredentials, getLogoutAction, getLogoutActionBuilder, getNonceSessionAttributeName, getRedirectionAction, getRedirectionActionBuilder, getStateSessionAttributeName, getUrlResolver, isCheckAuthenticationAttempt, newDefaultCallbackUrlResolver, setAjaxRequestResolver, setCallbackUrl, setCallbackUrlResolver, setCheckAuthenticationAttempt, setLogoutActionBuilder, setRedirectionActionBuilder, setUrlResolver
-
Methods inherited from class org.pac4j.core.client.BaseClient
addAuthorizationGenerator, addAuthorizationGenerators, defaultAuthenticator, defaultCredentialsExtractor, defaultProfileCreator, getAuthenticator, getAuthorizationGenerators, getCredentialsExtractor, getCustomProperties, getName, getProfileCreator, getProfileFactoryWhenNotAuthenticated, getSaveProfileInSession, getUserProfile, isMultiProfile, notifySessionRenewal, renewUserProfile, retrieveCredentials, retrieveUserProfile, setAuthenticator, setAuthorizationGenerator, setAuthorizationGenerators, setAuthorizationGenerators, setCredentialsExtractor, setCustomProperties, setMultiProfile, setName, setProfileCreator, setProfileFactoryWhenNotAuthenticated, setSaveProfileInSession
-
-
-
-
Field Detail
-
DEFAULT_SCOPE
public static final java.lang.String DEFAULT_SCOPE
- See Also:
- Constant Field Values
-
-
Method Detail
-
internalInit
protected void internalInit(boolean forceReinit)
- Overrides:
internalInit
in classOAuth20Client
-
getScope
public java.lang.String getScope()
-
setScope
public void setScope(java.lang.String scope)
-
-