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

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 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

Nested Classes

Modifier and Type	Class	Description
static class	Google2Client.Google2Scope

Field Summary

Fields

Modifier and Type	Field	Description
protected static java.lang.String	EMAIL_SCOPE
protected static java.lang.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, saveProfileInSession

Constructor Summary

Constructors

Constructor	Description
Google2Client()
Google2Client(java.lang.String key, java.lang.String secret)

Method Summary

Modifier and Type	Method	Description
Google2Client.Google2Scope	getScope()
protected void	internalInit(boolean forceReinit)
void	setScope(Google2Client.Google2Scope 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

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

getLastAttempt, getMaxAttempts, getMinTimeIntervalBetweenAttemptsInMilliseconds, getNbAttempts, init, init, isInitialized, reinit, setMaxAttempts, setMinTimeIntervalBetweenAttemptsInMilliseconds, shouldInitialize

Methods inherited from class java.lang.Object

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

Field Detail

PROFILE_SCOPE

protected static final java.lang.String PROFILE_SCOPE

See Also:

Constant Field Values

EMAIL_SCOPE

protected static final java.lang.String EMAIL_SCOPE

See Also:

Constant Field Values

scope

protected Google2Client.Google2Scope scope

Constructor Detail

Google2Client

public Google2Client()

Google2Client

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

Method Detail

internalInit

protected void internalInit(boolean forceReinit)

Overrides:

internalInit in class OAuth20Client

getScope

public Google2Client.Google2Scope getScope()

setScope

public void setScope(Google2Client.Google2Scope scope)