org.pac4j.oauth.profile.google2

Class Google2ProfileDefinition

java.lang.Object

org.pac4j.core.profile.definition.ProfileDefinition<P>

org.pac4j.core.profile.definition.CommonProfileDefinition<P>

org.pac4j.oauth.profile.definition.OAuthProfileDefinition<P,com.github.scribejava.core.model.OAuth2AccessToken,C>

org.pac4j.oauth.profile.definition.OAuth20ProfileDefinition<Google2Profile,OAuth20Configuration>

org.pac4j.oauth.profile.google2.Google2ProfileDefinition

public class Google2ProfileDefinition
extends OAuth20ProfileDefinition<Google2Profile,OAuth20Configuration>

This class is the Google profile definition (using OAuth 2.0 protocol).

Since:

1.2.0

Author:

Jerome Leleu

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	BIRTHDAY Deprecated.
static java.lang.String	DISPLAY_NAME Deprecated.
static java.lang.String	EMAIL Deprecated.
static java.lang.String	EMAIL_VERIFIED
static java.lang.String	EMAILS Deprecated.
static java.lang.String	FAMILY_NAME Deprecated.
static java.lang.String	GIVEN_NAME
static java.lang.String	LANGUAGE Deprecated.
static java.lang.String	NAME
static java.lang.String	PICTURE
static java.lang.String	PROFILE
static java.lang.String	URL Deprecated.

Fields inherited from class org.pac4j.core.profile.definition.CommonProfileDefinition

FIRST_NAME, GENDER, LOCALE, LOCATION, PICTURE_URL, PROFILE_URL

Fields inherited from class org.pac4j.core.profile.definition.ProfileDefinition

logger, newProfile

Constructor Summary

Constructors

Constructor and Description
Google2ProfileDefinition()

Method Summary

Modifier and Type	Method and Description
Google2Profile	extractUserProfile(java.lang.String body) Extract the user profile from the response (JSON, XML...) of the profile url.
java.lang.String	getProfileUrl(com.github.scribejava.core.model.OAuth2AccessToken accessToken, OAuth20Configuration configuration) Retrieve the url of the profile of the authenticated user for the provider.

Methods inherited from class org.pac4j.oauth.profile.definition.OAuthProfileDefinition

getProfileVerb, raiseProfileExtractionError, raiseProfileExtractionJsonError, raiseProfileExtractionJsonError

Methods inherited from class org.pac4j.core.profile.definition.ProfileDefinition

convertAndAdd, convertAndAdd, getConverters, getPrimaryAttributes, getProfileId, getSecondaryAttributes, newProfile, primary, secondary, setProfileFactory, setProfileId

Methods inherited from class java.lang.Object

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

Field Detail

DISPLAY_NAME

@Deprecated
public static final java.lang.String DISPLAY_NAME

Deprecated.

See Also:

Constant Field Values

URL

@Deprecated
public static final java.lang.String URL

Deprecated.

See Also:

Constant Field Values

FAMILY_NAME

@Deprecated
public static final java.lang.String FAMILY_NAME

Deprecated.

See Also:

Constant Field Values

EMAILS

@Deprecated
public static final java.lang.String EMAILS

Deprecated.

See Also:

Constant Field Values

LANGUAGE

@Deprecated
public static final java.lang.String LANGUAGE

Deprecated.

See Also:

Constant Field Values

BIRTHDAY

@Deprecated
public static final java.lang.String BIRTHDAY

Deprecated.

See Also:

Constant Field Values

EMAIL

@Deprecated
public static final java.lang.String EMAIL

Deprecated.

See Also:

Constant Field Values

EMAIL_VERIFIED

public static final java.lang.String EMAIL_VERIFIED

See Also:

Constant Field Values

GIVEN_NAME

public static final java.lang.String GIVEN_NAME

See Also:

Constant Field Values

NAME

public static final java.lang.String NAME

See Also:

Constant Field Values

PICTURE

public static final java.lang.String PICTURE

See Also:

Constant Field Values

PROFILE

public static final java.lang.String PROFILE

See Also:

Constant Field Values

Constructor Detail

Google2ProfileDefinition

public Google2ProfileDefinition()

Method Detail

getProfileUrl

public java.lang.String getProfileUrl(com.github.scribejava.core.model.OAuth2AccessToken accessToken,
                                      OAuth20Configuration configuration)

Description copied from class: OAuthProfileDefinition

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

Specified by:

getProfileUrl in class OAuthProfileDefinition<Google2Profile,com.github.scribejava.core.model.OAuth2AccessToken,OAuth20Configuration>

Parameters:

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

configuration - the current configuration

Returns:

the url of the user profile given by the provider

extractUserProfile

public Google2Profile extractUserProfile(java.lang.String body)

Description copied from class: OAuthProfileDefinition

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

Specified by:

extractUserProfile in class OAuthProfileDefinition<Google2Profile,com.github.scribejava.core.model.OAuth2AccessToken,OAuth20Configuration>

Parameters:

body - the response body

Returns:

the returned profile