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 final String	ALTERNATIVE_ID	Constant ALTERNATIVE_ID="alt_user_id"
protected static final String	BASE_URL	Constant BASE_URL="https://www.hiorg-server.de/api/oauth2/"{trunked}
static final String	FIRST_NAME	Constant FIRST_NAME="vorname"
static final String	FULL_NAME	Constant FULL_NAME="fullname"
static final String	LEADER	Constant LEADER="leitung"
static final String	NAME	Constant NAME="name"
static final String	ORGANISATION_ID	Constant ORGANISATION_ID="orga"
static final String	ORGANISATION_NAME	Constant ORGANISATION_NAME="organisation"
static final String	POSITION	Constant POSITION="funktion"
static final String	ROLES	Constant ROLES="gruppe"
static final String	TYPED_ALTERNATIVE_ID	Constant TYPED_ALTERNATIVE_ID="typed_alt_user_id"
static final String	USER_ID	Constant USER_ID="user_id"
static final String	USERNAME	Constant USERNAME="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()	Constructor for HiOrgServerProfileDefinition.

Method Summary

Modifier and Type	Method	Description
protected void	extractRoles(HiOrgServerProfile profile)	extractRoles.
HiOrgServerProfile	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

USER_ID

public static final String USER_ID

Constant USER_ID="user_id"

See Also:

• Constant Field Values

USERNAME

public static final String USERNAME

Constant USERNAME="username"

See Also:

• Constant Field Values

NAME

public static final String NAME

Constant NAME="name"

See Also:

• Constant Field Values

FIRST_NAME

public static final String FIRST_NAME

Constant FIRST_NAME="vorname"

See Also:

• Constant Field Values

FULL_NAME

public static final String FULL_NAME

Constant FULL_NAME="fullname"

See Also:

• Constant Field Values

ROLES

public static final String ROLES

Constant ROLES="gruppe"

See Also:

• Constant Field Values

LEADER

public static final String LEADER

Constant LEADER="leitung"

See Also:

• Constant Field Values

POSITION

public static final String POSITION

Constant POSITION="funktion"

See Also:

• Constant Field Values

ORGANISATION_ID

public static final String ORGANISATION_ID

Constant ORGANISATION_ID="orga"

See Also:

• Constant Field Values

ORGANISATION_NAME

public static final String ORGANISATION_NAME

Constant ORGANISATION_NAME="organisation"

See Also:

• Constant Field Values

ALTERNATIVE_ID

public static final String ALTERNATIVE_ID

Constant ALTERNATIVE_ID="alt_user_id"

See Also:

• Constant Field Values

TYPED_ALTERNATIVE_ID

public static final String TYPED_ALTERNATIVE_ID

Constant TYPED_ALTERNATIVE_ID="typed_alt_user_id"

See Also:

• Constant Field Values

BASE_URL

protected static final String BASE_URL

Constant BASE_URL="https://www.hiorg-server.de/api/oauth2/"{trunked}

See Also:

• Constant Field Values

Constructor Details

HiOrgServerProfileDefinition

public HiOrgServerProfileDefinition()

Constructor for HiOrgServerProfileDefinition.

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

extractRoles

protected void extractRoles(HiOrgServerProfile profile)

extractRoles.

Parameters:

profile - a HiOrgServerProfile object