org.pac4j.oauth.profile.definition

Class OAuthProfileDefinition<P extends CommonProfile,T extends com.github.scribejava.core.model.Token,O extends OAuthConfiguration>

java.lang.Object

org.pac4j.core.profile.definition.ProfileDefinition<P>

org.pac4j.core.profile.definition.CommonProfileDefinition<P>

org.pac4j.oauth.profile.definition.OAuthProfileDefinition<P,T,O>

Direct Known Subclasses:

OAuth10ProfileDefinition, OAuth20ProfileDefinition

public abstract class OAuthProfileDefinition<P extends CommonProfile,T extends com.github.scribejava.core.model.Token,O extends OAuthConfiguration>
extends CommonProfileDefinition<P>

OAuth profile definition.

Since:

2.0.0

Author:

Jerome Leleu

Field Summary

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
OAuthProfileDefinition()
OAuthProfileDefinition(Function<Object[],P> profileFactory)

Method Summary

Modifier and Type	Method and Description
abstract P	extractUserProfile(String body) Extract the user profile from the response (JSON, XML...) of the profile url.
abstract String	getProfileUrl(T accessToken, O configuration) Retrieve the url of the profile of the authenticated user for the provider.
com.github.scribejava.core.model.Verb	getProfileVerb() Get HTTP Method to request profile.

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

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

Constructor Detail

OAuthProfileDefinition

public OAuthProfileDefinition()

OAuthProfileDefinition

public OAuthProfileDefinition(Function<Object[],P> profileFactory)

Method Detail

getProfileVerb

public com.github.scribejava.core.model.Verb getProfileVerb()

Get HTTP Method to request profile.

Returns:

http verb

getProfileUrl

public abstract String getProfileUrl(T accessToken,
                                     O configuration)

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

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 abstract P extractUserProfile(String body)
                              throws HttpAction

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

Parameters:

body - the response body

Returns:

the returned profile

Throws:

HttpAction - whether an extra HTTP action is required