Package org.pac4j.oauth.client
Class Google2Client
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.Google2Client
- All Implemented Interfaces:
org.pac4j.core.client.Client
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
or
Google2Client.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
-
Field Summary
Modifier and TypeFieldDescriptionprotected static final String
ConstantEMAIL_SCOPE="email"
protected static final String
ConstantPROFILE_SCOPE="profile"
protected Google2Client.Google2Scope
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, saveProfileInSession
-
Constructor Summary
ConstructorDescriptionConstructor for Google2Client.Google2Client
(String key, String secret) Constructor for Google2Client. -
Method Summary
Modifier and TypeMethodDescriptiongetScope()
Getter for the fieldscope
.protected void
internalInit
(boolean forceReinit) void
Setter for the fieldscope
.Methods inherited from class org.pac4j.oauth.client.OAuth20Client
beforeInternalInit, getKey, getSecret, setKey, setSecret
Methods inherited from class org.pac4j.core.client.IndirectClient
afterInternalInit, checkCredentials, computeFinalCallbackUrl, getAjaxRequestResolver, getCallbackUrl, getCallbackUrlResolver, getCodeVerifierSessionAttributeName, getLogoutAction, getLogoutActionBuilder, getLogoutProcessor, getNonceSessionAttributeName, getRedirectionAction, getRedirectionActionBuilder, getStateSessionAttributeName, getUrlResolver, isCheckAuthenticationAttempt, newDefaultCallbackUrlResolver, processLogout, setAjaxRequestResolver, setCallbackUrl, setCallbackUrlResolver, setCheckAuthenticationAttempt, setLogoutActionBuilder, setLogoutActionBuilderIfUndefined, setLogoutProcessor, setLogoutProcessorIfUndefined, setRedirectionActionBuilder, setRedirectionActionBuilderIfUndefined, setUrlResolver, toString
Methods inherited from class org.pac4j.core.client.BaseClient
addAuthorizationGenerator, addAuthorizationGenerators, findSessionLogoutHandler, getAuthenticator, getAuthorizationGenerators, getConfig, getCredentials, getCredentialsExtractor, getCustomProperties, getLogger, getName, getProfileCreator, getProfileFactoryWhenNotAuthenticated, getSaveProfileInSession, getSaveProfileInSession, getUserProfile, internalValidateCredentials, isMultiProfile, isMultiProfile, notifySessionRenewal, renewUserProfile, setAuthenticator, setAuthenticatorIfUndefined, setAuthorizationGenerator, setAuthorizationGenerators, setAuthorizationGenerators, setConfig, setCredentialsExtractor, setCredentialsExtractorIfUndefined, setCustomProperties, setMultiProfile, setName, setProfileCreator, setProfileCreatorIfUndefined, setProfileFactoryWhenNotAuthenticated, setSaveProfileInSession, validateCredentials
Methods inherited from class org.pac4j.core.util.InitializableObject
getInitialized, getLastAttempt, getMaxAttempts, getMinTimeIntervalBetweenAttemptsInMilliseconds, getNbAttempts, init, init, isInitialized, reinit, setMaxAttempts, setMinTimeIntervalBetweenAttemptsInMilliseconds, shouldInitialize
-
Field Details
-
PROFILE_SCOPE
ConstantPROFILE_SCOPE="profile"
- See Also:
-
EMAIL_SCOPE
ConstantEMAIL_SCOPE="email"
- See Also:
-
scope
-
-
Constructor Details
-
Method Details
-
internalInit
protected void internalInit(boolean forceReinit) - Overrides:
internalInit
in classOAuth20Client
-
getScope
Getter for the field
scope
.- Returns:
- a
Google2Client.Google2Scope
object
-
setScope
Setter for the field
scope
.- Parameters:
scope
- aGoogle2Client.Google2Scope
object
-