Package org.pac4j.oauth.profile.casoauthwrapper

Class CasOAuthWrapperProfileDefinition

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.casoauthwrapper.CasOAuthWrapperProfileDefinition

public class CasOAuthWrapperProfileDefinition
extends OAuthProfileDefinition

CasOAuthWrapperProfile profile definition.

Since:

1.9.2

Author:

Jerome Leleu

Field Summary

Fields

Modifier and Type	Field	Description
static final String	AUTHENTICATION_DATE	Constant AUTHENTICATION_DATE="authenticationDate"
static final String	AUTHENTICATION_METHOD	Constant AUTHENTICATION_METHOD="authenticationMethod"
static final String	IS_FROM_NEW_LOGIN	Constant IS_FROM_NEW_LOGIN="isFromNewLogin"
static final String	LONG_TERM_AUTHENTICATION_REQUEST_TOKEN_USED	Constant LONG_TERM_AUTHENTICATION_REQUEST_TOKEN_USED="longTermAuthenticationRequestTokenUsed"
static final String	SUCCESSFUL_AUTHENTICATION_HANDLERS	Constant SUCCESSFUL_AUTHENTICATION_HANDLERS="successfulAuthenticationHandlers"

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

Constructors

Constructor	Description
CasOAuthWrapperProfileDefinition()	Constructor for 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.Token accessToken, OAuthConfiguration 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, getLogger, getParameter, getPrimaryAttributes, getProfileFactory, getProfileId, getSecondaryAttributes, isRestoreProfileFromTypedId, newProfile, primary, secondary, setProfileFactory, setProfileId, setRestoreProfileFromTypedId

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

IS_FROM_NEW_LOGIN

public static final String IS_FROM_NEW_LOGIN

Constant IS_FROM_NEW_LOGIN="isFromNewLogin"

See Also:

• Constant Field Values

AUTHENTICATION_DATE

public static final String AUTHENTICATION_DATE

Constant AUTHENTICATION_DATE="authenticationDate"

See Also:

• Constant Field Values

AUTHENTICATION_METHOD

public static final String AUTHENTICATION_METHOD

Constant AUTHENTICATION_METHOD="authenticationMethod"

See Also:

• Constant Field Values

SUCCESSFUL_AUTHENTICATION_HANDLERS

public static final String SUCCESSFUL_AUTHENTICATION_HANDLERS

Constant SUCCESSFUL_AUTHENTICATION_HANDLERS="successfulAuthenticationHandlers"

See Also:

• Constant Field Values

LONG_TERM_AUTHENTICATION_REQUEST_TOKEN_USED

public static final String LONG_TERM_AUTHENTICATION_REQUEST_TOKEN_USED

Constant LONG_TERM_AUTHENTICATION_REQUEST_TOKEN_USED="longTermAuthenticationRequestTokenUsed"

See Also:

• Constant Field Values

Constructor Details

CasOAuthWrapperProfileDefinition

public CasOAuthWrapperProfileDefinition()

Constructor for CasOAuthWrapperProfileDefinition.

Method Details

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 class OAuthProfileDefinition

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)

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

Specified by:

extractUserProfile in class OAuthProfileDefinition

Parameters:

body - the response body

Returns:

the returned profile