Package org.pac4j.oauth.profile.casoauthwrapper

Class CasOAuthWrapperProfileDefinition

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<CasOAuthWrapperProfile,OAuth20Configuration>

org.pac4j.oauth.profile.casoauthwrapper.CasOAuthWrapperProfileDefinition

public class CasOAuthWrapperProfileDefinition
extends OAuth20ProfileDefinition<CasOAuthWrapperProfile,OAuth20Configuration>

CasOAuthWrapperProfile profile definition.

Since:

1.9.2

Author:

Jerome Leleu

Field Summary

Fields

Modifier and Type	Field	Description
static String	AUTHENTICATION_DATE
static String	AUTHENTICATION_METHOD
static String	IS_FROM_NEW_LOGIN
static String	LONG_TERM_AUTHENTICATION_REQUEST_TOKEN_USED
static String	SUCCESSFUL_AUTHENTICATION_HANDLERS

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	Description
CasOAuthWrapperProfileDefinition()

Method Summary

Modifier and Type	Method	Description
CasOAuthWrapperProfile	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

IS_FROM_NEW_LOGIN

public static final String IS_FROM_NEW_LOGIN

See Also:

Constant Field Values

AUTHENTICATION_DATE

public static final String AUTHENTICATION_DATE

See Also:

Constant Field Values

AUTHENTICATION_METHOD

public static final String AUTHENTICATION_METHOD

See Also:

Constant Field Values

SUCCESSFUL_AUTHENTICATION_HANDLERS

public static final String SUCCESSFUL_AUTHENTICATION_HANDLERS

See Also:

Constant Field Values

LONG_TERM_AUTHENTICATION_REQUEST_TOKEN_USED

public static final String LONG_TERM_AUTHENTICATION_REQUEST_TOKEN_USED

See Also:

Constant Field Values

Constructor Detail

CasOAuthWrapperProfileDefinition

public CasOAuthWrapperProfileDefinition()

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<CasOAuthWrapperProfile,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 CasOAuthWrapperProfile 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<CasOAuthWrapperProfile,com.github.scribejava.core.model.OAuth2AccessToken,OAuth20Configuration>

Parameters:

body - the response body

Returns:

the returned profile