org.pac4j.oauth.profile.generic

Class GenericOAuth20ProfileDefinition

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

org.pac4j.oauth.profile.generic.GenericOAuth20ProfileDefinition

public class GenericOAuth20ProfileDefinition
extends OAuth20ProfileDefinition<OAuth20Profile>

This class is the user profile for generic OAuth2 with appropriate getters.

The map of profileAttributes is intended to replate the primary/secondary attributes where the key is the name of the attribute and the value is the path to obtain that attribute from the json resopnse, starting from firstNodePath

Author:

Julio Arrebola

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
GenericOAuth20ProfileDefinition()

Method Summary

Modifier and Type	Method and Description
OAuth20Profile	extractUserProfile(String body) Extract the user profile from the response (JSON, XML...) of the profile url.
String	getFirstNodePath()
Map<String,String>	getProfileAttributes()
String	getProfileUrl(com.github.scribejava.core.model.OAuth2AccessToken accessToken, OAuth20Configuration 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.
void	profileAttribute(String name, AttributeConverter<? extends Object> converter) Add an attribute as a primary one and its converter.
void	profileAttribute(String name, String tag, AttributeConverter<? extends Object> converter) Add an attribute as a primary one and its converter.
void	setFirstNodePath(String firstNodePath)
void	setProfileUrl(String profileUrl)
void	setProfileVerb(com.github.scribejava.core.model.Verb value)

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

GenericOAuth20ProfileDefinition

public GenericOAuth20ProfileDefinition()

Method Detail

setProfileVerb

public void setProfileVerb(com.github.scribejava.core.model.Verb value)

getProfileVerb

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

Description copied from class: OAuthProfileDefinition

Get HTTP Method to request profile.

Overrides:

getProfileVerb in class OAuthProfileDefinition<OAuth20Profile,com.github.scribejava.core.model.OAuth2AccessToken,OAuth20Configuration>

Returns:

http verb

setProfileUrl

public void setProfileUrl(String profileUrl)

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

getProfileAttributes

public Map<String,String> getProfileAttributes()

profileAttribute

public void profileAttribute(String name,
                             AttributeConverter<? extends Object> converter)

Add an attribute as a primary one and its converter.

Parameters:

name - name of the attribute

converter - converter

profileAttribute

public void profileAttribute(String name,
                             String tag,
                             AttributeConverter<? extends Object> converter)

Add an attribute as a primary one and its converter.

Parameters:

name - name of the attribute

tag - json reference

converter - converter

getFirstNodePath

public String getFirstNodePath()

setFirstNodePath

public void setFirstNodePath(String firstNodePath)