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

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

org.pac4j.oauth.profile.google2.Google2ProfileDefinition

public class Google2ProfileDefinition
extends OAuth20ProfileDefinition<Google2Profile>

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 String	BIRTHDAY
static String	DISPLAY_NAME
static String	EMAILS
static String	FAMILY_NAME
static String	GIVEN_NAME
static String	LANGUAGE
static String	PICTURE
static String	URL

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

EMAIL, 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(String body) Extract the user profile from the response (JSON, XML...) of the profile url.
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

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

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

Methods inherited from class java.lang.Object

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

Field Detail

DISPLAY_NAME

public static final String DISPLAY_NAME

See Also:

Constant Field Values

GIVEN_NAME

public static final String GIVEN_NAME

See Also:

Constant Field Values

FAMILY_NAME

public static final String FAMILY_NAME

See Also:

Constant Field Values

URL

public static final String URL

See Also:

Constant Field Values

PICTURE

public static final String PICTURE

See Also:

Constant Field Values

LANGUAGE

public static final String LANGUAGE

See Also:

Constant Field Values

BIRTHDAY

public static final String BIRTHDAY

See Also:

Constant Field Values

EMAILS

public static final String EMAILS

See Also:

Constant Field Values

Constructor Detail

Google2ProfileDefinition

public Google2ProfileDefinition()

Method Detail

getProfileUrl

public 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(String body)
                                  throws HttpAction

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

Throws:

HttpAction - whether an extra HTTP action is required