org.pac4j.oauth.profile.ok

Class OkProfile

java.lang.Object

org.pac4j.core.profile.UserProfile

org.pac4j.core.profile.CommonProfile

org.pac4j.oauth.profile.OAuth20Profile

org.pac4j.oauth.profile.ok.OkProfile

All Implemented Interfaces:

Externalizable, Serializable, Clearable

public class OkProfile
extends OAuth20Profile

Represents basic (OAuth20Profile) profile on Ok.ru (Odnoklassniki.ru)

Since:

1.8

Author:

imayka (imayka[at]ymail[dot]com)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static String	BASE_PROFILE_URL

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
OkProfile()

Method Summary

Modifier and Type	Method and Description
protected AttributesDefinition	getAttributesDefinition() Return the attributes definition for this user profile.
String	getDisplayName() Return the displayed name of the user.
String	getEmail() Return the email of the user.
String	getFamilyName() Return the family name of the user.
String	getFirstName() Return the first name of the user.
Gender	getGender() Return the gender of the user.
Locale	getLocale() Return the locale of the user.
String	getLocation() Return the location 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.
String	getUsername() Return the username of the user.

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

clear, getAccessToken, setAccessToken

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

Field Detail

BASE_PROFILE_URL

public static final String BASE_PROFILE_URL

See Also:

Constant Field Values

Constructor Detail

OkProfile

public OkProfile()

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

getUsername

public String getUsername()

Description copied from class: CommonProfile

Return the username of the user. It can be a login or a specific username.

Overrides:

getUsername in class CommonProfile

Returns:

the username of the user

getGender

public Gender getGender()

Description copied from class: CommonProfile

Return the gender of the user.

Overrides:

getGender in class CommonProfile

Returns:

the gender 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.

getLocation

public String getLocation()

Description copied from class: CommonProfile

Return the location of the user.

Overrides:

getLocation in class CommonProfile

Returns:

the locationle of the user