Package org.pac4j.oauth.profile.ok

Class OkProfileDefinition

java.lang.Object

org.pac4j.core.profile.definition.ProfileDefinition

org.pac4j.core.profile.definition.CommonProfileDefinition

org.pac4j.oauth.profile.definition.OAuthProfileDefinition

org.pac4j.oauth.profile.ok.OkProfileDefinition

public class OkProfileDefinition
extends OAuthProfileDefinition

Represents the profile definitions on Ok.ru (Odnoklassniki.ru)

Since:

1.8

Author:

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

Field Summary

Fields

Modifier and Type	Field	Description
static final String	AGE	Constant AGE="age"
static final String	BIRTHDAY	Constant BIRTHDAY="birthday"
static final String	CURRENT_STATUS	Constant CURRENT_STATUS="current_status"
static final String	CURRENT_STATUS_DATE	Constant CURRENT_STATUS_DATE="current_status_date"
static final String	CURRENT_STATUS_ID	Constant CURRENT_STATUS_ID="current_status_id"
static final String	HAS_EMAIL	Constant HAS_EMAIL="has_email"
static final String	LAST_NAME	Constant LAST_NAME="last_name"
static final String	LOCATION_CITY	Constant LOCATION_CITY="location.city"
static final String	LOCATION_COUNTRY	Constant LOCATION_COUNTRY="location.country"
static final String	LOCATION_COUNTRY_CODE	Constant LOCATION_COUNTRY_CODE="location.countryCode"
static final String	LOCATION_COUNTRY_NAME	Constant LOCATION_COUNTRY_NAME="location.countryName"
static final String	NAME	Constant NAME="name"
static final String	ONLINE	Constant ONLINE="online"
static final String	PIC_1	Constant PIC_1="pic_1"
static final String	PIC_2	Constant PIC_2="pic_2"
static final String	UID	Constant UID="uid"

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

DISPLAY_NAME, EMAIL, FAMILY_NAME, FIRST_NAME, GENDER, LOCALE, LOCATION, PICTURE_URL, PROFILE_URL

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

logger

Constructor Summary

Constructors

Constructor	Description
OkProfileDefinition()	Constructor for OkProfileDefinition.

Method Summary

Modifier and Type	Method	Description
OkProfile	extractUserProfile(String body)	Extract the user profile from the response (JSON, XML...) of the profile url.
protected String	getMD5SignAsHexString(String strForEncoding)	getMD5SignAsHexString.
String	getProfileUrl(com.github.scribejava.core.model.Token token, OAuthConfiguration 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.CommonProfileDefinition

configurePrimaryAttributes

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

convertAndAdd, convertAndAdd, getConverters, getLogger, getParameter, getPrimaryAttributes, getProfileFactory, getProfileId, getSecondaryAttributes, isRestoreProfileFromTypedId, newProfile, primary, secondary, setProfileFactory, setProfileId, setRestoreProfileFromTypedId

Methods inherited from class java.lang.Object

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

Field Details

UID

public static final String UID

Constant UID="uid"

See Also:

• Constant Field Values

BIRTHDAY

public static final String BIRTHDAY

Constant BIRTHDAY="birthday"

See Also:

• Constant Field Values

AGE

public static final String AGE

Constant AGE="age"

See Also:

• Constant Field Values

NAME

public static final String NAME

Constant NAME="name"

See Also:

• Constant Field Values

LOCATION_CITY

public static final String LOCATION_CITY

Constant LOCATION_CITY="location.city"

See Also:

• Constant Field Values

LOCATION_COUNTRY

public static final String LOCATION_COUNTRY

Constant LOCATION_COUNTRY="location.country"

See Also:

• Constant Field Values

LOCATION_COUNTRY_CODE

public static final String LOCATION_COUNTRY_CODE

Constant LOCATION_COUNTRY_CODE="location.countryCode"

See Also:

• Constant Field Values

LOCATION_COUNTRY_NAME

public static final String LOCATION_COUNTRY_NAME

Constant LOCATION_COUNTRY_NAME="location.countryName"

See Also:

• Constant Field Values

ONLINE

public static final String ONLINE

Constant ONLINE="online"

See Also:

• Constant Field Values

LAST_NAME

public static final String LAST_NAME

Constant LAST_NAME="last_name"

See Also:

• Constant Field Values

HAS_EMAIL

public static final String HAS_EMAIL

Constant HAS_EMAIL="has_email"

See Also:

• Constant Field Values

CURRENT_STATUS

public static final String CURRENT_STATUS

Constant CURRENT_STATUS="current_status"

See Also:

• Constant Field Values

CURRENT_STATUS_ID

public static final String CURRENT_STATUS_ID

Constant CURRENT_STATUS_ID="current_status_id"

See Also:

• Constant Field Values

CURRENT_STATUS_DATE

public static final String CURRENT_STATUS_DATE

Constant CURRENT_STATUS_DATE="current_status_date"

See Also:

• Constant Field Values

PIC_1

public static final String PIC_1

Constant PIC_1="pic_1"

See Also:

• Constant Field Values

PIC_2

public static final String PIC_2

Constant PIC_2="pic_2"

See Also:

• Constant Field Values

Constructor Details

OkProfileDefinition

public OkProfileDefinition()

Constructor for OkProfileDefinition.

Method Details

getProfileUrl

public String getProfileUrl(com.github.scribejava.core.model.Token token,
 OAuthConfiguration configuration)

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

Specified by:

getProfileUrl in class OAuthProfileDefinition

Parameters:

token - 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

getMD5SignAsHexString

protected String getMD5SignAsHexString(String strForEncoding)
                                throws NoSuchAlgorithmException

getMD5SignAsHexString.

Parameters:

strForEncoding - a String object

Returns:

a String object

Throws:

NoSuchAlgorithmException - if any.

extractUserProfile

public OkProfile extractUserProfile(String body)

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

Specified by:

extractUserProfile in class OAuthProfileDefinition

Parameters:

body - the response body

Returns:

the returned profile