Package org.pac4j.oauth.profile.vk

Class VkProfileDefinition

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.vk.VkProfileDefinition

public class VkProfileDefinition
extends OAuthProfileDefinition

This class is the Vk profile definition.

Since:

1.5

Author:

indvdum (gotoindvdum[at]gmail[dot]com)

Field Summary

Fields

Modifier and Type	Field	Description
protected static final String	BASE_URL	Constant BASE_URL="https://api.vk.com/method/users.get"
static final String	BIRTH_DATE	Constant BIRTH_DATE="bdate"
static final String	CAN_POST	Constant CAN_POST="can_post"
static final String	CAN_SEE_ALL_POST	Constant CAN_SEE_ALL_POST="can_see_all_posts"
static final String	CAN_SEE_AUDIO	Constant CAN_SEE_AUDIO="can_see_audio"
static final String	CAN_WRITE_PRIVATE_MESSAGE	Constant CAN_WRITE_PRIVATE_MESSAGE="can_write_private_message"
static final String	COMMON_COUNT	Constant COMMON_COUNT="common_count"
static final String	DOMAIN	Constant DOMAIN="domain"
static final String	HAS_MOBILE	Constant HAS_MOBILE="has_mobile"
static final String	HOME_PHONE	Constant HOME_PHONE="home_phone"
static final String	LAST_NAME	Constant LAST_NAME="last_name"
static final String	MOBILE_PHONE	Constant MOBILE_PHONE="mobile_phone"
static final String	ONLINE	Constant ONLINE="online"
static final String	ONLINE_MOBILE	Constant ONLINE_MOBILE="online_mobile"
static final String	PHOTO_100	Constant PHOTO_100="photo_100"
static final String	PHOTO_200	Constant PHOTO_200="photo_200"
static final String	PHOTO_200_ORIG	Constant PHOTO_200_ORIG="photo_200_orig"
static final String	PHOTO_400_ORIG	Constant PHOTO_400_ORIG="photo_400_orig"
static final String	PHOTO_50	Constant PHOTO_50="photo_50"
static final String	PHOTO_MAX	Constant PHOTO_MAX="photo_max"
static final String	PHOTO_MAX_ORIG	Constant PHOTO_MAX_ORIG="photo_max_orig"
static final String	RELATION	Constant RELATION="relation"
static final String	SEX	Constant SEX="sex"
static final String	SITE	Constant SITE="site"
static final String	SKYPE	Constant SKYPE="skype"
static final String	STATUS	Constant STATUS="status"

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
VkProfileDefinition()	Constructor for VkProfileDefinition.

Method Summary

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

LAST_NAME

public static final String LAST_NAME

Constant LAST_NAME="last_name"

See Also:

• Constant Field Values

SEX

public static final String SEX

Constant SEX="sex"

See Also:

• Constant Field Values

BIRTH_DATE

public static final String BIRTH_DATE

Constant BIRTH_DATE="bdate"

See Also:

• Constant Field Values

PHOTO_50

public static final String PHOTO_50

Constant PHOTO_50="photo_50"

See Also:

• Constant Field Values

PHOTO_100

public static final String PHOTO_100

Constant PHOTO_100="photo_100"

See Also:

• Constant Field Values

PHOTO_200_ORIG

public static final String PHOTO_200_ORIG

Constant PHOTO_200_ORIG="photo_200_orig"

See Also:

• Constant Field Values

PHOTO_200

public static final String PHOTO_200

Constant PHOTO_200="photo_200"

See Also:

• Constant Field Values

PHOTO_400_ORIG

public static final String PHOTO_400_ORIG

Constant PHOTO_400_ORIG="photo_400_orig"

See Also:

• Constant Field Values

PHOTO_MAX

public static final String PHOTO_MAX

Constant PHOTO_MAX="photo_max"

See Also:

• Constant Field Values

PHOTO_MAX_ORIG

public static final String PHOTO_MAX_ORIG

Constant PHOTO_MAX_ORIG="photo_max_orig"

See Also:

• Constant Field Values

ONLINE

public static final String ONLINE

Constant ONLINE="online"

See Also:

• Constant Field Values

ONLINE_MOBILE

public static final String ONLINE_MOBILE

Constant ONLINE_MOBILE="online_mobile"

See Also:

• Constant Field Values

DOMAIN

public static final String DOMAIN

Constant DOMAIN="domain"

See Also:

• Constant Field Values

HAS_MOBILE

public static final String HAS_MOBILE

Constant HAS_MOBILE="has_mobile"

See Also:

• Constant Field Values

MOBILE_PHONE

public static final String MOBILE_PHONE

Constant MOBILE_PHONE="mobile_phone"

See Also:

• Constant Field Values

HOME_PHONE

public static final String HOME_PHONE

Constant HOME_PHONE="home_phone"

See Also:

• Constant Field Values

SKYPE

public static final String SKYPE

Constant SKYPE="skype"

See Also:

• Constant Field Values

SITE

public static final String SITE

Constant SITE="site"

See Also:

• Constant Field Values

CAN_POST

public static final String CAN_POST

Constant CAN_POST="can_post"

See Also:

• Constant Field Values

CAN_SEE_ALL_POST

public static final String CAN_SEE_ALL_POST

Constant CAN_SEE_ALL_POST="can_see_all_posts"

See Also:

• Constant Field Values

CAN_SEE_AUDIO

public static final String CAN_SEE_AUDIO

Constant CAN_SEE_AUDIO="can_see_audio"

See Also:

• Constant Field Values

CAN_WRITE_PRIVATE_MESSAGE

public static final String CAN_WRITE_PRIVATE_MESSAGE

Constant CAN_WRITE_PRIVATE_MESSAGE="can_write_private_message"

See Also:

• Constant Field Values

STATUS

public static final String STATUS

Constant STATUS="status"

See Also:

• Constant Field Values

COMMON_COUNT

public static final String COMMON_COUNT

Constant COMMON_COUNT="common_count"

See Also:

• Constant Field Values

RELATION

public static final String RELATION

Constant RELATION="relation"

See Also:

• Constant Field Values

BASE_URL

protected static final String BASE_URL

Constant BASE_URL="https://api.vk.com/method/users.get"

See Also:

• Constant Field Values

Constructor Details

VkProfileDefinition

public VkProfileDefinition()

Constructor for VkProfileDefinition.

Method Details

getProfileUrl

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

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

Specified by:

getProfileUrl in class OAuthProfileDefinition

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