org.pac4j.oauth.client

Class Google2Client

java.lang.Object

org.pac4j.core.util.InitializableWebObject

org.pac4j.core.client.BaseClient<C,U>

org.pac4j.core.client.IndirectClient<OAuthCredentials,U>

org.pac4j.oauth.client.BaseOAuthClient<U>

org.pac4j.oauth.client.BaseOAuth20Client

org.pac4j.oauth.client.BaseOAuth20StateClient<Google2Profile>

org.pac4j.oauth.client.Google2Client

All Implemented Interfaces:

Cloneable, Client

public class Google2Client
extends BaseOAuth20StateClient<Google2Profile>

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

See Also:

Google2Profile

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Google2Client.Google2Scope

Field Summary

Fields

Modifier and Type	Field and Description
protected String	EMAIL_SCOPE
protected String	PROFILE_SCOPE
protected Google2Client.Google2Scope	scope
protected String	scopeValue

Fields inherited from class org.pac4j.oauth.client.BaseOAuth20Client

logger, OAUTH_CODE

Fields inherited from class org.pac4j.oauth.client.BaseOAuthClient

connectTimeout, key, proxyHost, proxyPort, readTimeout, secret, service, tokenAsHeader

Fields inherited from class org.pac4j.core.client.IndirectClient

ATTEMPTED_AUTHENTICATION_SUFFIX, callbackUrl, callbackUrlResolver, NEEDS_CLIENT_REDIRECTION_PARAMETER

Constructor Summary

Constructors

Constructor and Description
Google2Client()
Google2Client(String key, String secret)

Method Summary

Modifier and Type	Method and Description
protected Google2Profile	extractUserProfile(String body) Extract the user profile from the response (JSON, XML...) of the profile url.
protected String	getProfileUrl(org.scribe.model.Token accessToken) Retrieve the url of the profile of the authenticated user for the provider.
Google2Client.Google2Scope	getScope()
protected boolean	hasBeenCancelled(WebContext context) Return if the authentication has been cancelled.
protected void	internalInit(WebContext context)
protected Google2Client	newClient()
protected String	retrieveAuthorizationUrl(WebContext context)
void	setScope(Google2Client.Google2Scope scope)
void	setUseStateParameter(boolean requiresStateParameter) Enable or disable usage of the 'state' parameter as a CSRF protection in OAuth.

Methods inherited from class org.pac4j.oauth.client.BaseOAuth20StateClient

getAuthorizationUrl, getOAuthCredentials, getState, setState

Methods inherited from class org.pac4j.oauth.client.BaseOAuth20Client

getAccessToken, isDirectRedirection

Methods inherited from class org.pac4j.oauth.client.BaseOAuthClient

addAccessTokenToProfile, clone, createProxyRequest, getClientType, getConnectTimeout, getKey, getProxyHost, getProxyPort, getReadTimeout, getSecret, getUserProfile, isTokenAsHeader, retrieveCredentials, retrieveRedirectAction, retrieveUserProfile, retrieveUserProfileFromToken, sendRequestForData, sendRequestForData, setConnectTimeout, setKey, setProxyHost, setProxyPort, setReadTimeout, setSecret, setTokenAsHeader

Methods inherited from class org.pac4j.core.client.IndirectClient

computeFinalCallbackUrl, getAjaxRequestResolver, getCallbackUrl, getCallbackUrlResolver, getCredentials, getRedirectAction, getRedirectionUrl, getStateParameter, isIncludeClientNameInCallbackUrl, redirect, setAjaxRequestResolver, setCallbackUrl, setCallbackUrlResolver, setIncludeClientNameInCallbackUrl

Methods inherited from class org.pac4j.core.client.BaseClient

addAuthorizationGenerator, getAuthorizationGenerators, getName, getUserProfile, setAuthorizationGenerator, setAuthorizationGenerators, setAuthorizationGenerators, setName, toString

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

init, reinit

Methods inherited from class java.lang.Object

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

Field Detail

PROFILE_SCOPE

protected final String PROFILE_SCOPE

See Also:

Constant Field Values

EMAIL_SCOPE

protected final String EMAIL_SCOPE

See Also:

Constant Field Values

scope

protected Google2Client.Google2Scope scope

scopeValue

protected String scopeValue

Constructor Detail

Google2Client

public Google2Client()

Google2Client

public Google2Client(String key,
                     String secret)

Method Detail

newClient

protected Google2Client newClient()

Specified by:

newClient in class BaseClient

internalInit

protected void internalInit(WebContext context)

Overrides:

internalInit in class BaseOAuthClient

getProfileUrl

protected String getProfileUrl(org.scribe.model.Token accessToken)

Description copied from class: BaseOAuthClient

Retrieve the url of the profile of the authenticated user for the provider.

Specified by:

getProfileUrl in class BaseOAuthClient

Parameters:

accessToken - only used when constructing dynamic urls from data in the token

Returns:

the url of the user profile given by the provider

extractUserProfile

protected Google2Profile extractUserProfile(String body)

Description copied from class: BaseOAuthClient

Extract the user profile from the response (JSON, XML...) of the profile url.

Specified by:

extractUserProfile in class BaseOAuthClient

Parameters:

body - the response body

Returns:

the user profile object

getScope

public Google2Client.Google2Scope getScope()

setScope

public void setScope(Google2Client.Google2Scope scope)

hasBeenCancelled

protected boolean hasBeenCancelled(WebContext context)

Description copied from class: BaseOAuthClient

Return if the authentication has been cancelled.

Specified by:

hasBeenCancelled in class BaseOAuthClient

Parameters:

context - the web context.

Returns:

if the authentication has been cancelled.

setUseStateParameter

public void setUseStateParameter(boolean requiresStateParameter)

Enable or disable usage of the 'state' parameter as a CSRF protection in OAuth. Default is true.

Parameters:

requiresStateParameter - whether the 'state' parameter must be used

retrieveAuthorizationUrl

protected String retrieveAuthorizationUrl(WebContext context)

Overrides:

retrieveAuthorizationUrl in class BaseOAuth20StateClient<Google2Profile>