Package org.pac4j.oauth.client
Class Google2Client
- 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.Google2Client
-
- All Implemented Interfaces:
Client<OAuth20Credentials>
public class Google2Client extends OAuth20Client
This class is the OAuth client to authenticate users in Google using OAuth protocol version 2.0.
The scope is by default :
Google2Client.Google2Scope.EMAIL_AND_PROFILE
, but it can also but set to :Google2Client.Google2Scope.PROFILE
orGoogle2Client.Google2Scope.EMAIL
.It returns a
Google2Profile
.More information at https://developers.google.com/accounts/docs/OAuth2Login
- Since:
- 1.2.0
- Author:
- Jerome Leleu
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
Google2Client.Google2Scope
-
Field Summary
Fields Modifier and Type Field Description protected static String
EMAIL_SCOPE
protected static String
PROFILE_SCOPE
protected Google2Client.Google2Scope
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 Google2Client()
Google2Client(String key, String secret)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description protected void
clientInit()
Google2Client.Google2Scope
getScope()
void
setScope(Google2Client.Google2Scope 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
-
PROFILE_SCOPE
protected static final String PROFILE_SCOPE
- See Also:
- Constant Field Values
-
EMAIL_SCOPE
protected static final String EMAIL_SCOPE
- See Also:
- Constant Field Values
-
scope
protected Google2Client.Google2Scope scope
-
-
Method Detail
-
clientInit
protected void clientInit()
- Overrides:
clientInit
in classOAuth20Client
-
getScope
public Google2Client.Google2Scope getScope()
-
setScope
public void setScope(Google2Client.Google2Scope scope)
-
-