Package org.pac4j.oauth.profile.qq

Class QQProfileDefinition

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.qq.QQProfileDefinition

public class QQProfileDefinition
extends OAuthProfileDefinition

This class defines the attributes of the Tencent QQ Connect profile.

More info at: get_user_info

Since:

3.1.0

Author:

zhangzhenli

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CITY	Constant CITY="city"
static final String	FIGUREURL	Constant FIGUREURL="figureurl"
static final String	FIGUREURL_1	Constant FIGUREURL_1="figureurl_1"
static final String	FIGUREURL_2	Constant FIGUREURL_2="figureurl_2"
static final String	FIGUREURL_QQ_1	Constant FIGUREURL_QQ_1="figureurl_qq_1"
static final String	FIGUREURL_QQ_2	Constant FIGUREURL_QQ_2="figureurl_qq_2"
static final String	MSG	Constant MSG="msg"
static final String	NICKNAME	Constant NICKNAME="nickname"
static final Pattern	OPENID_REGEX	Constant OPENID_REGEX
static final String	PROVINCE	Constant PROVINCE="province"
static final String	RET	Constant RET="ret"
static final String	YEAR	Constant YEAR="year"

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

Method Summary

Modifier and Type	Method	Description
String	extractOpenid(String body)	extractOpenid.
protected static String	extractParameter(CharSequence response, Pattern regexPattern, boolean required)	extractParameter.
QQProfile	extractUserProfile(String body)	Extract the user profile from the response (JSON, XML...) of the profile url.
String	getOpenidUrl(com.github.scribejava.core.model.OAuth2AccessToken accessToken, OAuth20Configuration configuration)	getOpenidUrl.
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

OPENID_REGEX

public static final Pattern OPENID_REGEX

Constant OPENID_REGEX

RET

public static final String RET

Constant RET="ret"

See Also:

• Constant Field Values

MSG

public static final String MSG

Constant MSG="msg"

See Also:

• Constant Field Values

NICKNAME

public static final String NICKNAME

Constant NICKNAME="nickname"

See Also:

• Constant Field Values

PROVINCE

public static final String PROVINCE

Constant PROVINCE="province"

See Also:

• Constant Field Values

CITY

public static final String CITY

Constant CITY="city"

See Also:

• Constant Field Values

YEAR

public static final String YEAR

Constant YEAR="year"

See Also:

• Constant Field Values

FIGUREURL

public static final String FIGUREURL

Constant FIGUREURL="figureurl"

See Also:

• Constant Field Values

FIGUREURL_1

public static final String FIGUREURL_1

Constant FIGUREURL_1="figureurl_1"

See Also:

• Constant Field Values

FIGUREURL_2

public static final String FIGUREURL_2

Constant FIGUREURL_2="figureurl_2"

See Also:

• Constant Field Values

FIGUREURL_QQ_1

public static final String FIGUREURL_QQ_1

Constant FIGUREURL_QQ_1="figureurl_qq_1"

See Also:

• Constant Field Values

FIGUREURL_QQ_2

public static final String FIGUREURL_QQ_2

Constant FIGUREURL_QQ_2="figureurl_qq_2"

See Also:

• Constant Field Values

Constructor Details

QQProfileDefinition

public QQProfileDefinition()

Constructor for QQProfileDefinition.

Method Details

getOpenidUrl

public String getOpenidUrl(com.github.scribejava.core.model.OAuth2AccessToken accessToken,
 OAuth20Configuration configuration)

getOpenidUrl.

Parameters:

accessToken - a OAuth2AccessToken object

configuration - a OAuth20Configuration object

Returns:

a String object

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

extractOpenid

public String extractOpenid(String body)

extractOpenid.

Parameters:

body - a String object

Returns:

a String object

extractParameter

protected static String extractParameter(CharSequence response,
 Pattern regexPattern,
 boolean required)
                                  throws com.github.scribejava.core.exceptions.OAuthException

extractParameter.

Parameters:

response - a String object

regexPattern - a Pattern object

required - a boolean

Returns:

a String object

Throws:

com.github.scribejava.core.exceptions.OAuthException - if any.