Package org.pac4j.oauth.profile.hiorgserver

Class HiOrgServerProfileDefinition

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.hiorgserver.HiOrgServerProfileDefinition

public class HiOrgServerProfileDefinition
extends OAuthProfileDefinition

This class is the HiOrg-Server profile definition.

Since:

3.2.0

Author:

Martin Böhmer

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	ALTERNATIVE_ID
protected static java.lang.String	BASE_URL
static java.lang.String	FIRST_NAME
static java.lang.String	FULL_NAME
static java.lang.String	LEADER
static java.lang.String	NAME
static java.lang.String	ORGANISATION_ID
static java.lang.String	ORGANISATION_NAME
static java.lang.String	POSITION
static java.lang.String	ROLES
static java.lang.String	TYPED_ALTERNATIVE_ID
static java.lang.String	USER_ID
static java.lang.String	USERNAME

Fields inherited from class org.pac4j.core.profile.definition.CommonProfileDefinition

DISPLAY_NAME, EMAIL, FAMILY_NAME, GENDER, LOCALE, LOCATION, PICTURE_URL, PROFILE_URL

Fields inherited from class org.pac4j.core.profile.definition.ProfileDefinition

logger

Constructor Summary

Constructors

Constructor	Description
HiOrgServerProfileDefinition()

Method Summary

Modifier and Type	Method	Description
protected void	extractRoles(HiOrgServerProfile profile)
HiOrgServerProfile	extractUserProfile(java.lang.String body)	Extract the user profile from the response (JSON, XML...) of the profile url.
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.

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, getParameter, getPrimaryAttributes, 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 Detail

USER_ID

public static final java.lang.String USER_ID

See Also:

Constant Field Values

USERNAME

public static final java.lang.String USERNAME

See Also:

Constant Field Values

NAME

public static final java.lang.String NAME

See Also:

Constant Field Values

FIRST_NAME

public static final java.lang.String FIRST_NAME

See Also:

Constant Field Values

FULL_NAME

public static final java.lang.String FULL_NAME

See Also:

Constant Field Values

ROLES

public static final java.lang.String ROLES

See Also:

Constant Field Values

LEADER

public static final java.lang.String LEADER

See Also:

Constant Field Values

POSITION

public static final java.lang.String POSITION

See Also:

Constant Field Values

ORGANISATION_ID

public static final java.lang.String ORGANISATION_ID

See Also:

Constant Field Values

ORGANISATION_NAME

public static final java.lang.String ORGANISATION_NAME

See Also:

Constant Field Values

ALTERNATIVE_ID

public static final java.lang.String ALTERNATIVE_ID

See Also:

Constant Field Values

TYPED_ALTERNATIVE_ID

public static final java.lang.String TYPED_ALTERNATIVE_ID

See Also:

Constant Field Values

BASE_URL

protected static final java.lang.String BASE_URL

See Also:

Constant Field Values

Constructor Detail

HiOrgServerProfileDefinition

public HiOrgServerProfileDefinition()

Method Detail

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

Parameters:

body - the response body

Returns:

the returned profile

extractRoles

protected void extractRoles(HiOrgServerProfile profile)