Package org.pac4j.oidc.profile
Class OidcProfile
- java.lang.Object
-
- org.pac4j.core.profile.BasicUserProfile
-
- org.pac4j.core.profile.CommonProfile
-
- org.pac4j.core.profile.jwt.AbstractJwtProfile
-
- org.pac4j.oidc.profile.OidcProfile
-
- All Implemented Interfaces:
Externalizable
,Serializable
,UserProfile
- 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.BasicUserProfile
logger, SEPARATOR
-
-
Constructor Summary
Constructors Constructor Description OidcProfile()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
clearSensitiveData()
com.nimbusds.oauth2.sdk.token.AccessToken
getAccessToken()
String
getAcr()
Object
getAmr()
Date
getAuthTime()
String
getAzp()
String
getDisplayName()
Boolean
getEmailVerified()
String
getFirstName()
com.nimbusds.jwt.JWT
getIdToken()
String
getIdTokenString()
String
getLocation()
String
getMiddleName()
String
getNickname()
String
getNonce()
String
getPhoneNumber()
Boolean
getPhoneNumberVerified()
URI
getPictureUrl()
URI
getProfileUrl()
com.nimbusds.oauth2.sdk.token.RefreshToken
getRefreshToken()
int
getTokenExpirationAdvance()
Date
getUpdatedAt()
String
getUsername()
boolean
isExpired()
void
setAccessToken(com.nimbusds.oauth2.sdk.token.AccessToken accessToken)
void
setIdTokenString(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
getEmail, getFamilyName, getGender, getLocale
-
Methods inherited from class org.pac4j.core.profile.BasicUserProfile
addAttribute, addAttributes, addAuthenticationAttribute, addAuthenticationAttributes, addPermission, addPermissions, addRole, 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
-
Methods inherited from interface org.pac4j.core.profile.UserProfile
asPrincipal
-
-
-
-
Method Detail
-
getFirstName
public String getFirstName()
- Overrides:
getFirstName
in classCommonProfile
-
getMiddleName
public String getMiddleName()
-
getDisplayName
public String getDisplayName()
- Overrides:
getDisplayName
in classCommonProfile
-
getNickname
public String getNickname()
-
getUsername
public String getUsername()
- Specified by:
getUsername
in interfaceUserProfile
- Overrides:
getUsername
in classCommonProfile
-
getPictureUrl
public URI getPictureUrl()
- Overrides:
getPictureUrl
in classCommonProfile
-
getProfileUrl
public URI getProfileUrl()
- Overrides:
getProfileUrl
in classCommonProfile
-
getLocation
public String getLocation()
- Overrides:
getLocation
in classCommonProfile
-
getEmailVerified
public Boolean getEmailVerified()
-
getPhoneNumber
public String getPhoneNumber()
-
getPhoneNumberVerified
public Boolean getPhoneNumberVerified()
-
getUpdatedAt
public Date getUpdatedAt()
-
getAuthTime
public Date getAuthTime()
-
getNonce
public String getNonce()
-
getAcr
public String getAcr()
-
getAmr
public Object getAmr()
-
getAzp
public String getAzp()
-
setAccessToken
public void setAccessToken(com.nimbusds.oauth2.sdk.token.AccessToken accessToken)
-
getAccessToken
public com.nimbusds.oauth2.sdk.token.AccessToken getAccessToken()
-
getIdTokenString
public String getIdTokenString()
-
setIdTokenString
public void setIdTokenString(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 classBasicUserProfile
-
getTokenExpirationAdvance
public int getTokenExpirationAdvance()
-
setTokenExpirationAdvance
public void setTokenExpirationAdvance(int tokenExpirationAdvance)
-
isExpired
public boolean isExpired()
- Specified by:
isExpired
in interfaceUserProfile
- Overrides:
isExpired
in classCommonProfile
-
-