Package org.pac4j.oauth.profile.wordpress

Class WordPressProfileDefinition

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

org.pac4j.oauth.profile.definition.OAuth20ProfileDefinition<WordPressProfile,OAuth20Configuration>

org.pac4j.oauth.profile.wordpress.WordPressProfileDefinition

public class WordPressProfileDefinition
extends OAuth20ProfileDefinition<WordPressProfile,OAuth20Configuration>

This class is the WordPress profile definition.

Since:

1.1.0

Author:

Jerome Leleu

Field Summary

Fields

Modifier and Type	Field	Description
static String	AVATAR_URL
static String	LINKS
static String	PRIMARY_BLOG
static String	PROFILE_URL

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

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

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

logger, newProfile

Constructor Summary

Constructors

Constructor	Description
WordPressProfileDefinition()

Method Summary

Modifier and Type	Method	Description
WordPressProfile	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, 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, getPrimaryAttributes, getProfileId, getSecondaryAttributes, newProfile, primary, secondary, setProfileFactory, setProfileId

Methods inherited from class java.lang.Object

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

Field Detail

PRIMARY_BLOG

public static final String PRIMARY_BLOG

See Also:

Constant Field Values

AVATAR_URL

public static final String AVATAR_URL

See Also:

Constant Field Values

PROFILE_URL

public static final String PROFILE_URL

See Also:

Constant Field Values

LINKS

public static final String LINKS

See Also:

Constant Field Values

Constructor Detail

WordPressProfileDefinition

public WordPressProfileDefinition()

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<WordPressProfile,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 WordPressProfile extractUserProfile(String body)

Description copied from class: OAuthProfileDefinition

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

Specified by:

extractUserProfile in class OAuthProfileDefinition<WordPressProfile,com.github.scribejava.core.model.OAuth2AccessToken,OAuth20Configuration>

Parameters:

body - the response body

Returns:

the returned profile