org.pac4j.oauth.profile.vk

Class VkProfileDefinition

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

org.pac4j.oauth.profile.vk.VkProfileDefinition

public class VkProfileDefinition
extends OAuth20ProfileDefinition<VkProfile>

This class is the Vk profile definition.

Since:

1.5

Author:

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

Field Summary

Fields

Modifier and Type	Field and Description
protected static String	BASE_URL
static String	BIRTH_DATE
static String	CAN_POST
static String	CAN_SEE_ALL_POST
static String	CAN_SEE_AUDIO
static String	CAN_WRITE_PRIVATE_MESSAGE
static String	COMMON_COUNT
static String	DOMAIN
static String	HAS_MOBILE
static String	HOME_PHONE
static String	LAST_NAME
static String	MOBILE_PHONE
static String	ONLINE
static String	ONLINE_MOBILE
static String	PHOTO_100
static String	PHOTO_200
static String	PHOTO_200_ORIG
static String	PHOTO_400_ORIG
static String	PHOTO_50
static String	PHOTO_MAX
static String	PHOTO_MAX_ORIG
static String	RELATION
static String	SEX
static String	SITE
static String	SKYPE
static String	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, newProfile

Constructor Summary

Constructors

Constructor and Description
VkProfileDefinition()

Method Summary

Modifier and Type	Method and 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.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

LAST_NAME

public static final String LAST_NAME

See Also:

Constant Field Values

SEX

public static final String SEX

See Also:

Constant Field Values

BIRTH_DATE

public static final String BIRTH_DATE

See Also:

Constant Field Values

PHOTO_50

public static final String PHOTO_50

See Also:

Constant Field Values

PHOTO_100

public static final String PHOTO_100

See Also:

Constant Field Values

PHOTO_200_ORIG

public static final String PHOTO_200_ORIG

See Also:

Constant Field Values

PHOTO_200

public static final String PHOTO_200

See Also:

Constant Field Values

PHOTO_400_ORIG

public static final String PHOTO_400_ORIG

See Also:

Constant Field Values

PHOTO_MAX

public static final String PHOTO_MAX

See Also:

Constant Field Values

PHOTO_MAX_ORIG

public static final String PHOTO_MAX_ORIG

See Also:

Constant Field Values

ONLINE

public static final String ONLINE

See Also:

Constant Field Values

ONLINE_MOBILE

public static final String ONLINE_MOBILE

See Also:

Constant Field Values

DOMAIN

public static final String DOMAIN

See Also:

Constant Field Values

HAS_MOBILE

public static final String HAS_MOBILE

See Also:

Constant Field Values

MOBILE_PHONE

public static final String MOBILE_PHONE

See Also:

Constant Field Values

HOME_PHONE

public static final String HOME_PHONE

See Also:

Constant Field Values

SKYPE

public static final String SKYPE

See Also:

Constant Field Values

SITE

public static final String SITE

See Also:

Constant Field Values

CAN_POST

public static final String CAN_POST

See Also:

Constant Field Values

CAN_SEE_ALL_POST

public static final String CAN_SEE_ALL_POST

See Also:

Constant Field Values

CAN_SEE_AUDIO

public static final String CAN_SEE_AUDIO

See Also:

Constant Field Values

CAN_WRITE_PRIVATE_MESSAGE

public static final String CAN_WRITE_PRIVATE_MESSAGE

See Also:

Constant Field Values

STATUS

public static final String STATUS

See Also:

Constant Field Values

COMMON_COUNT

public static final String COMMON_COUNT

See Also:

Constant Field Values

RELATION

public static final String RELATION

See Also:

Constant Field Values

BASE_URL

protected static final String BASE_URL

See Also:

Constant Field Values

Constructor Detail

VkProfileDefinition

public VkProfileDefinition()

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