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
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 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
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionextractUserProfile
(String body) Extract the user profile from the response (JSON, XML...) of the profile url.Getter for the fieldfirstNodePath
.Getter for the fieldprofileAttributes
.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
Get HTTP Method to request profile.void
profileAttribute
(String name, String tag, org.pac4j.core.profile.converter.AttributeConverter converter) Add an attribute as a primary one and its converter.void
profileAttribute
(String name, org.pac4j.core.profile.converter.AttributeConverter converter) Add an attribute as a primary one and its converter.void
setFirstNodePath
(String firstNodePath) Setter for the fieldfirstNodePath
.void
setProfileUrl
(String profileUrl) Setter for the fieldprofileUrl
.void
setProfileVerb
(com.github.scribejava.core.model.Verb value) Setter for the fieldprofileVerb
.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, getLogger, getParameter, getPrimaryAttributes, getProfileFactory, getProfileId, getSecondaryAttributes, isRestoreProfileFromTypedId, newProfile, primary, secondary, setProfileFactory, setProfileId, setRestoreProfileFromTypedId
-
Constructor Details
-
GenericOAuth20ProfileDefinition
public GenericOAuth20ProfileDefinition()
-
-
Method Details
-
setProfileVerb
public void setProfileVerb(com.github.scribejava.core.model.Verb value) Setter for the field
profileVerb
.- Parameters:
value
- aVerb
object
-
getProfileVerb
public com.github.scribejava.core.model.Verb getProfileVerb()Get HTTP Method to request profile.- Overrides:
getProfileVerb
in classOAuthProfileDefinition
- Returns:
- http verb
-
setProfileUrl
Setter for the field
profileUrl
.- Parameters:
profileUrl
- aString
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 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
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
Getter for the field
profileAttributes
.- Returns:
- a
Map
object
-
profileAttribute
public void profileAttribute(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(String name, 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
Getter for the field
firstNodePath
.- Returns:
- a
String
object
-
setFirstNodePath
Setter for the field
firstNodePath
.- Parameters:
firstNodePath
- aString
object
-