Package org.pac4j.oauth.profile.generic
Class GenericOAuth20ProfileDefinition
- 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.generic.GenericOAuth20ProfileDefinition
-
public class GenericOAuth20ProfileDefinition extends OAuthProfileDefinition
This class is the user profile for generic OAuth2 with appropriate getters.
The map of
profileAttributes
is intended to replace 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 response starting fromfirstNodePath
- Author:
- Julio Arrebola
-
-
Constructor Summary
Constructors Constructor Description GenericOAuth20ProfileDefinition()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description OAuth20Profile
extractUserProfile(java.lang.String body)
Extract the user profile from the response (JSON, XML...) of the profile url.java.lang.String
getFirstNodePath()
java.util.Map<java.lang.String,java.lang.String>
getProfileAttributes()
java.lang.String
getProfileUrl(com.github.scribejava.core.model.Token accessToken, OAuthConfiguration 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(java.lang.String name, java.lang.String tag, org.pac4j.core.profile.converter.AttributeConverter converter)
Add an attribute as a primary one and its converter.void
profileAttribute(java.lang.String name, org.pac4j.core.profile.converter.AttributeConverter converter)
Add an attribute as a primary one and its converter.void
setFirstNodePath(java.lang.String firstNodePath)
void
setProfileUrl(java.lang.String profileUrl)
void
setProfileVerb(com.github.scribejava.core.model.Verb value)
-
Methods inherited from class org.pac4j.oauth.profile.definition.OAuthProfileDefinition
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, getParameter, getPrimaryAttributes, getProfileId, getSecondaryAttributes, isRestoreProfileFromTypedId, newProfile, primary, secondary, setProfileFactory, setProfileId, setRestoreProfileFromTypedId
-
-
-
-
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 classOAuthProfileDefinition
- Returns:
- http verb
-
setProfileUrl
public void setProfileUrl(java.lang.String profileUrl)
-
getProfileUrl
public java.lang.String getProfileUrl(com.github.scribejava.core.model.Token accessToken, OAuthConfiguration configuration)
Description copied from class:OAuthProfileDefinition
Retrieve the url of the profile of the authenticated user for the provider.- Specified by:
getProfileUrl
in classOAuthProfileDefinition
- Parameters:
accessToken
- only used when constructing dynamic urls from data in the tokenconfiguration
- the current configuration- Returns:
- the url of the user profile given by the provider
-
extractUserProfile
public OAuth20Profile extractUserProfile(java.lang.String body)
Description copied from class:OAuthProfileDefinition
Extract the user profile from the response (JSON, XML...) of the profile url.- Specified by:
extractUserProfile
in classOAuthProfileDefinition
- Parameters:
body
- the response body- Returns:
- the returned profile
-
getProfileAttributes
public java.util.Map<java.lang.String,java.lang.String> getProfileAttributes()
-
profileAttribute
public void profileAttribute(java.lang.String name, org.pac4j.core.profile.converter.AttributeConverter converter)
Add an attribute as a primary one and its converter.- Parameters:
name
- name of the attributeconverter
- converter
-
profileAttribute
public void profileAttribute(java.lang.String name, java.lang.String tag, org.pac4j.core.profile.converter.AttributeConverter converter)
Add an attribute as a primary one and its converter.- Parameters:
name
- name of the attributetag
- json referenceconverter
- converter
-
getFirstNodePath
public java.lang.String getFirstNodePath()
-
setFirstNodePath
public void setFirstNodePath(java.lang.String firstNodePath)
-
-