org.pac4j.oidc.profile

Class OidcProfile

java.lang.Object

org.pac4j.core.profile.UserProfile

org.pac4j.core.profile.CommonProfile

org.pac4j.core.profile.jwt.AbstractJwtProfile

org.pac4j.oidc.profile.OidcProfile

All Implemented Interfaces:

java.io.Externalizable, java.io.Serializable

Direct Known Subclasses:

AzureAdProfile, GoogleOidcProfile, KeycloakOidcProfile

public class OidcProfile
extends AbstractJwtProfile

This class is the user profile for sites using OpenID Connect protocol.

It is returned by the OidcClient.

Version:

1.7.0

Author:

Michael Remond

See Also:

Serialized Form

Field Summary

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

logger, SEPARATOR

Constructor Summary

Constructors

Constructor and Description
OidcProfile()

Method Summary

Modifier and Type	Method and Description
void	clearSensitiveData()
com.nimbusds.oauth2.sdk.token.AccessToken	getAccessToken()
java.lang.String	getAcr()
java.lang.Object	getAmr()
java.util.Date	getAuthTime()
java.lang.String	getAzp()
java.lang.String	getDisplayName()
java.lang.Boolean	getEmailVerified()
java.lang.String	getFirstName()
com.nimbusds.jwt.JWT	getIdToken()
java.lang.String	getIdTokenString()
java.lang.String	getLocation()
java.lang.String	getMiddleName()
java.lang.String	getNickname()
java.lang.String	getNonce()
java.lang.String	getPhoneNumber()
java.lang.Boolean	getPhoneNumberVerified()
java.net.URI	getPictureUrl()
java.net.URI	getProfileUrl()
com.nimbusds.oauth2.sdk.token.RefreshToken	getRefreshToken()
int	getTokenExpirationAdvance()
java.util.Date	getUpdatedAt()
java.lang.String	getUsername()
boolean	isExpired()
void	setAccessToken(com.nimbusds.oauth2.sdk.token.AccessToken accessToken)
void	setIdTokenString(java.lang.String idToken)
void	setRefreshToken(com.nimbusds.oauth2.sdk.token.RefreshToken refreshToken)
void	setTokenExpirationAdvance(int tokenExpirationAdvance)

Methods inherited from class org.pac4j.core.profile.jwt.AbstractJwtProfile

getAudience, getExpirationDate, getIssuedAt, getIssuer, getNotBefore, getSubject

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

asPrincipal, getEmail, getFamilyName, getGender, getLocale

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

OidcProfile

public OidcProfile()

Method Detail

getFirstName

public java.lang.String getFirstName()

Overrides:

getFirstName in class CommonProfile

getMiddleName

public java.lang.String getMiddleName()

getDisplayName

public java.lang.String getDisplayName()

Overrides:

getDisplayName in class CommonProfile

getNickname

public java.lang.String getNickname()

getUsername

public java.lang.String getUsername()

Overrides:

getUsername in class CommonProfile

getPictureUrl

public java.net.URI getPictureUrl()

Overrides:

getPictureUrl in class CommonProfile

getProfileUrl

public java.net.URI getProfileUrl()

Overrides:

getProfileUrl in class CommonProfile

getLocation

public java.lang.String getLocation()

Overrides:

getLocation in class CommonProfile

getEmailVerified

public java.lang.Boolean getEmailVerified()

getPhoneNumber

public java.lang.String getPhoneNumber()

getPhoneNumberVerified

public java.lang.Boolean getPhoneNumberVerified()

getUpdatedAt

public java.util.Date getUpdatedAt()

getAuthTime

public java.util.Date getAuthTime()

getNonce

public java.lang.String getNonce()

getAcr

public java.lang.String getAcr()

getAmr

public java.lang.Object getAmr()

getAzp

public java.lang.String getAzp()

setAccessToken

public void setAccessToken(com.nimbusds.oauth2.sdk.token.AccessToken accessToken)

getAccessToken

public com.nimbusds.oauth2.sdk.token.AccessToken getAccessToken()

getIdTokenString

public java.lang.String getIdTokenString()

setIdTokenString

public void setIdTokenString(java.lang.String idToken)

getIdToken

public com.nimbusds.jwt.JWT getIdToken()

getRefreshToken

public com.nimbusds.oauth2.sdk.token.RefreshToken getRefreshToken()

setRefreshToken

public void setRefreshToken(com.nimbusds.oauth2.sdk.token.RefreshToken refreshToken)

clearSensitiveData

public void clearSensitiveData()

Overrides:

clearSensitiveData in class UserProfile

getTokenExpirationAdvance

public int getTokenExpirationAdvance()

setTokenExpirationAdvance

public void setTokenExpirationAdvance(int tokenExpirationAdvance)

isExpired

public boolean isExpired()

Overrides:

isExpired in class CommonProfile