org.pac4j.oauth.profile.google2

Class Google2Profile

java.lang.Object

org.pac4j.core.profile.UserProfile

org.pac4j.core.profile.CommonProfile

org.pac4j.oauth.profile.OAuth20Profile

org.pac4j.oauth.profile.google2.Google2Profile

All Implemented Interfaces:

Externalizable, Serializable, Clearable

public class Google2Profile
extends OAuth20Profile

This class is the user profile for Google (using OAuth protocol version 2) with appropriate getters.

It is returned by the Google2Client.

Method :	From the JSON profile response :
The attributes of the CommonProfile
String getEmail()	the email attribute
String getFirstName()	the givenName attribute
String getFamilyName()	the familyName attribute
String getDisplayName()	the displayName attribute
String getUsername()	null
Gender getGender()	the gender attribute
Locale getLocale()	the language attribute
String getPictureUrl()	the image.url attribute
String getProfileUrl()	the url attribute
String getLocation()	null
More specific attributes
Date getBirthday()	the birthday attribute
List<Google2Email> getEmails()	the emails attribute

Since:

1.2.0

Author:

Jerome Leleu

See Also:

Google2Client, Serialized Form

Field Summary

Fields inherited from class org.pac4j.core.profile.CommonProfile

USERNAME

Fields inherited from class org.pac4j.core.profile.UserProfile

logger, SEPARATOR

Constructor Summary

Constructors

Constructor and Description
Google2Profile()

Method Summary

Modifier and Type	Method and Description
protected AttributesDefinition	getAttributesDefinition() Return the attributes definition for this user profile.
Date	getBirthday()
String	getDisplayName() Return the displayed name of the user.
String	getEmail() Return the email of the user.
List<Google2Email>	getEmails()
String	getFamilyName() Return the family name of the user.
String	getFirstName() Return the first name of the user.
Locale	getLocale() Return the locale of the user.
String	getPictureUrl() Return the url of the picture of the user.
String	getProfileUrl() Return the url of the profile of the user.

Methods inherited from class org.pac4j.oauth.profile.OAuth20Profile

clear, getAccessToken, setAccessToken

Methods inherited from class org.pac4j.core.profile.CommonProfile

getGender, getLocation, getUsername

Methods inherited from class org.pac4j.core.profile.UserProfile

addAttribute, addAttributes, addPermission, addPermissions, addRole, addRoles, build, getAttribute, getAttribute, getAttributes, getId, getPermissions, getRoles, getTypedId, isRemembered, readExternal, setId, setRemembered, toString, writeExternal

Methods inherited from class java.lang.Object

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

Constructor Detail

Google2Profile

public Google2Profile()

Method Detail

getAttributesDefinition

protected AttributesDefinition getAttributesDefinition()

Description copied from class: UserProfile

Return the attributes definition for this user profile. Null for this (generic) user profile.

Overrides:

getAttributesDefinition in class UserProfile

Returns:

the attributes definition

getEmail

public String getEmail()

Description copied from class: CommonProfile

Return the email of the user.

Overrides:

getEmail in class CommonProfile

Returns:

the email of the user

getFirstName

public String getFirstName()

Description copied from class: CommonProfile

Return the first name of the user.

Overrides:

getFirstName in class CommonProfile

Returns:

the first name of the user

getFamilyName

public String getFamilyName()

Description copied from class: CommonProfile

Return the family name of the user.

Overrides:

getFamilyName in class CommonProfile

Returns:

the family name of the user

getDisplayName

public String getDisplayName()

Description copied from class: CommonProfile

Return the displayed name of the user. It can be the username or the first and last names (separated by a space).

Overrides:

getDisplayName in class CommonProfile

Returns:

the displayed name of the user

getLocale

public Locale getLocale()

Description copied from class: CommonProfile

Return the locale of the user.

Overrides:

getLocale in class CommonProfile

Returns:

the locale of the user

getPictureUrl

public String getPictureUrl()

Description copied from class: CommonProfile

Return the url of the picture of the user.

Overrides:

getPictureUrl in class CommonProfile

Returns:

the url of the picture of the user.

getProfileUrl

public String getProfileUrl()

Description copied from class: CommonProfile

Return the url of the profile of the user.

Overrides:

getProfileUrl in class CommonProfile

Returns:

the url of the profile of the user.

getBirthday

public Date getBirthday()

getEmails

public List<Google2Email> getEmails()