org.pac4j.oauth.profile.hiorgserver

Class HiOrgServerProfile

java.lang.Object

org.pac4j.core.profile.UserProfile

org.pac4j.core.profile.CommonProfile

org.pac4j.oauth.profile.OAuth20Profile

org.pac4j.oauth.profile.hiorgserver.HiOrgServerProfile

All Implemented Interfaces:

Externalizable, Serializable

public class HiOrgServerProfile
extends OAuth20Profile

This class is the user profile for HiOrg-Server with appropriate getters. It is returned by the HiOrgServerClient.

Since:

3.2.0

Author:

Martin Boehmer

See Also:

Serialized Form

Field Summary

Fields inherited from class org.pac4j.core.profile.UserProfile

logger, SEPARATOR

Constructor Summary

Constructors

Constructor and Description
HiOrgServerProfile()

Method Summary

Modifier and Type	Method and Description
String	getAlternativeId() An alternative identifier to uniquely identify a HiOrg-Server user.
String	getDisplayName() Return the displayed name of the user.
String	getFamilyName() Return the family name of the user.
String	getFirstName() Return the first name of the user.
String	getOrganisationId()
String	getOrganisationName()
String	getPosition()
int	getRolesAsInteger()
String	getTypedAlternativeId() A alternative, typed identifier based on getAlternativeId().
String	getUsername() Return the username of the user.
boolean	hasRole(int roleId)
boolean	isLeader()

Methods inherited from class org.pac4j.oauth.profile.OAuth20Profile

clearSensitiveData, getAccessToken, setAccessToken

Methods inherited from class org.pac4j.core.profile.CommonProfile

asPrincipal, getEmail, getGender, getLocale, getLocation, getPictureUrl, getProfileUrl, isExpired

Methods inherited from class org.pac4j.core.profile.UserProfile

addAttribute, addAttributes, addAuthenticationAttribute, addAuthenticationAttributes, addPermission, addPermissions, addRole, addRoles, addRoles, build, build, containsAttribute, containsAuthenicationAttribute, getAttribute, getAttribute, getAttributes, getAuthenticationAttribute, getAuthenticationAttribute, getAuthenticationAttributes, getClientName, getId, getLinkedId, getPermissions, getRoles, getTypedId, isRemembered, readExternal, removeAttribute, removeAuthenticationAttribute, setClientName, setId, setLinkedId, setPermissions, setRemembered, setRoles, toString, writeExternal

Methods inherited from class java.lang.Object

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

Constructor Detail

HiOrgServerProfile

public HiOrgServerProfile()

Method Detail

getUsername

public String getUsername()

Description copied from class: CommonProfile

Return the username of the user. It can be a login or a specific username.

Overrides:

getUsername in class CommonProfile

Returns:

the username of the user

getFirstName

public String getFirstName()

Description copied from class: CommonProfile

Return the first name of the user.

Overrides:

getFirstName in class CommonProfile

Returns:

the first name of the user

getFamilyName

public String getFamilyName()

Description copied from class: CommonProfile

Return the family name of the user.

Overrides:

getFamilyName in class CommonProfile

Returns:

the family name of the user

getDisplayName

public String getDisplayName()

Description copied from class: CommonProfile

Return the displayed name of the user. It can be the username or the first and last names (separated by a space).

Overrides:

getDisplayName in class CommonProfile

Returns:

the displayed name of the user

getRolesAsInteger

public int getRolesAsInteger()

hasRole

public boolean hasRole(int roleId)

getOrganisationId

public String getOrganisationId()

getOrganisationName

public String getOrganisationName()

getPosition

public String getPosition()

isLeader

public boolean isLeader()

getAlternativeId

public String getAlternativeId()

An alternative identifier to uniquely identify a HiOrg-Server user.

Returns:

username and the organisation id, joined by an at-sign, lowercase

getTypedAlternativeId

public String getTypedAlternativeId()

A alternative, typed identifier based on getAlternativeId().

Returns:

the class name and getAlternativeId(), joined by the seperator constant