Package org.keycloak.models.map.storage.jpa.user.entity

Class JpaUserEntity

java.lang.Object

org.keycloak.models.map.common.UpdatableEntity.Impl

org.keycloak.models.map.user.MapUserEntity.AbstractUserEntity

org.keycloak.models.map.storage.jpa.user.entity.JpaUserEntity

All Implemented Interfaces:

Serializable, AbstractEntity, EntityWithAttributes, UpdatableEntity, JpaRootEntity, JpaRootVersionedEntity, MapUserEntity

@Entity
public class JpaUserEntity
extends MapUserEntity.AbstractUserEntity
implements JpaRootVersionedEntity

JPA MapUserEntity implementation. Some fields are annotated with @Column(insertable = false, updatable = false) to indicate that they are automatically generated from json fields. As such, these fields are non-insertable and non-updatable.

Author:

Stefan Guilhen

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface org.keycloak.models.map.user.MapUserEntity

MapUserEntity.AbstractUserEntity

Nested classes/interfaces inherited from interface org.keycloak.models.map.common.UpdatableEntity

UpdatableEntity.Impl

Field Summary

Fields inherited from class org.keycloak.models.map.common.UpdatableEntity.Impl

updated

Constructor Summary

Constructors

Constructor	Description
JpaUserEntity()	No-argument constructor, used by hibernate to instantiate entities.
JpaUserEntity(UUID id, int version, Integer entityVersion, String realmId, String username, String usernameWithCase, String firstName, String lastName, String email, String emailConstraint, String federationLink, Boolean enabled, Boolean emailVerified, Long timestamp)	Used by hibernate when calling cb.construct from read(QueryParameters) method.
JpaUserEntity(DeepCloner cloner)

Method Summary

Modifier and Type	Method	Description
void	addCredential(MapUserCredentialEntity credentialEntity)
void	addFederatedIdentity(MapUserFederatedIdentityEntity federatedIdentity)
void	addGroupsMembership(String groupId)
void	addRequiredAction(String requiredAction)
void	addRolesMembership(String roleId)
void	addUserConsent(MapUserConsentEntity userConsentEntity)
boolean	equals(Object obj)
List<String>	getAttribute(String name)
Map<String,List<String>>	getAttributes()
Long	getCreatedTimestamp()
Optional<MapUserCredentialEntity>	getCredential(String id)
List<MapUserCredentialEntity>	getCredentials()
Integer	getCurrentSchemaVersion()
String	getEmail()
String	getEmailConstraint()
Integer	getEntityVersion()
Set<MapUserFederatedIdentityEntity>	getFederatedIdentities()
Optional<MapUserFederatedIdentityEntity>	getFederatedIdentity(String identityProviderId)
String	getFederationLink()
String	getFirstName()
Set<String>	getGroupsMembership()
String	getId()
String	getLastName()
Long	getNotBefore()
String	getRealmId()
Set<String>	getRequiredActions()
Set<String>	getRolesMembership()
String	getServiceAccountClientLink()
Optional<MapUserConsentEntity>	getUserConsent(String clientId)
Set<MapUserConsentEntity>	getUserConsents()
String	getUsername()
int	getVersion()	Version of the JPA entity used for optimistic locking
int	hashCode()
Boolean	isEmailVerified()
Boolean	isEnabled()
boolean	isMetadataInitialized()
void	removeAttribute(String name)
Boolean	removeCredential(String id)
Boolean	removeCredential(MapUserCredentialEntity credentialEntity)
Boolean	removeFederatedIdentity(String identityProviderId)
Boolean	removeFederatedIdentity(MapUserFederatedIdentityEntity federatedIdentity)
void	removeGroupsMembership(String groupId)
void	removeRequiredAction(String requiredAction)
void	removeRolesMembership(String roleId)
Boolean	removeUserConsent(String clientId)
Boolean	removeUserConsent(MapUserConsentEntity userConsentEntity)
void	setAttribute(String name, List<String> values)
void	setAttributes(Map<String,List<String>> attributes)
void	setCreatedTimestamp(Long createdTimestamp)
void	setCredentials(List<MapUserCredentialEntity> credentials)
void	setEmail(String email)
void	setEmailConstraint(String emailConstraint)
void	setEmailVerified(Boolean emailVerified)
void	setEnabled(Boolean enabled)
void	setEntityVersion(Integer entityVersion)
void	setFederatedIdentities(Set<MapUserFederatedIdentityEntity> federatedIdentities)
void	setFederationLink(String federationLink)
void	setFirstName(String firstName)
void	setGroupsMembership(Set<String> groupsMembership)
void	setId(String id)
void	setLastName(String lastName)
void	setNotBefore(Long notBefore)
void	setRealmId(String realmId)
void	setRequiredActions(Set<String> requiredActions)
void	setRolesMembership(Set<String> rolesMembership)
void	setServiceAccountClientLink(String serviceAccountClientLink)
void	setUserConsents(Set<MapUserConsentEntity> userConsents)
void	setUsername(String username)

Methods inherited from class org.keycloak.models.map.user.MapUserEntity.AbstractUserEntity

clearUpdatedFlag, isUpdated, moveCredential, setEmail

Methods inherited from class org.keycloak.models.map.common.UpdatableEntity.Impl

markUpdatedFlag

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.keycloak.models.map.storage.jpa.JpaRootEntity

updateEntityVersion

Methods inherited from interface org.keycloak.models.map.user.MapUserEntity

credentialManager

Methods inherited from interface org.keycloak.models.map.common.UpdatableEntity

markUpdatedFlag

Constructor Details

JpaUserEntity

public JpaUserEntity()

No-argument constructor, used by hibernate to instantiate entities.

JpaUserEntity

public JpaUserEntity(DeepCloner cloner)

JpaUserEntity

public JpaUserEntity(UUID id,
 int version,
 Integer entityVersion,
 String realmId,
 String username,
 String usernameWithCase,
 String firstName,
 String lastName,
 String email,
 String emailConstraint,
 String federationLink,
 Boolean enabled,
 Boolean emailVerified,
 Long timestamp)

Used by hibernate when calling cb.construct from read(QueryParameters) method. It is used to select user without metadata(json) field.

Method Details

isMetadataInitialized

public boolean isMetadataInitialized()

getEntityVersion

public Integer getEntityVersion()

Specified by:

getEntityVersion in interface JpaRootEntity

Returns:

current supported version of the JPA entity used for schema versioning.

setEntityVersion

public void setEntityVersion(Integer entityVersion)

Specified by:

setEntityVersion in interface JpaRootEntity

Parameters:

entityVersion - sets current supported version to JPA entity.

getCurrentSchemaVersion

public Integer getCurrentSchemaVersion()

Specified by:

getCurrentSchemaVersion in interface JpaRootEntity

getVersion

public int getVersion()

Description copied from interface: JpaRootVersionedEntity

Version of the JPA entity used for optimistic locking

Specified by:

getVersion in interface JpaRootVersionedEntity

getId

public String getId()

Specified by:

getId in interface AbstractEntity

Overrides:

getId in class MapUserEntity.AbstractUserEntity

setId

public void setId(String id)

Specified by:

setId in interface AbstractEntity

Overrides:

setId in class MapUserEntity.AbstractUserEntity

getRealmId

public String getRealmId()

Specified by:

getRealmId in interface MapUserEntity

setRealmId

public void setRealmId(String realmId)

Specified by:

setRealmId in interface MapUserEntity

getUsername

public String getUsername()

Specified by:

getUsername in interface MapUserEntity

Returns:

User's username with respecting letter case.

setUsername

public void setUsername(String username)

Specified by:

setUsername in interface MapUserEntity

getFirstName

public String getFirstName()

Specified by:

getFirstName in interface MapUserEntity

setFirstName

public void setFirstName(String firstName)

Specified by:

setFirstName in interface MapUserEntity

getCreatedTimestamp

public Long getCreatedTimestamp()

Specified by:

getCreatedTimestamp in interface MapUserEntity

setCreatedTimestamp

public void setCreatedTimestamp(Long createdTimestamp)

Specified by:

setCreatedTimestamp in interface MapUserEntity

getLastName

public String getLastName()

Specified by:

getLastName in interface MapUserEntity

setLastName

public void setLastName(String lastName)

Specified by:

setLastName in interface MapUserEntity

getEmail

public String getEmail()

Specified by:

getEmail in interface MapUserEntity

setEmail

public void setEmail(String email)

Specified by:

setEmail in interface MapUserEntity

isEnabled

public Boolean isEnabled()

Specified by:

isEnabled in interface MapUserEntity

setEnabled

public void setEnabled(Boolean enabled)

Specified by:

setEnabled in interface MapUserEntity

isEmailVerified

public Boolean isEmailVerified()

Specified by:

isEmailVerified in interface MapUserEntity

setEmailVerified

public void setEmailVerified(Boolean emailVerified)

Specified by:

setEmailVerified in interface MapUserEntity

getEmailConstraint

public String getEmailConstraint()

Specified by:

getEmailConstraint in interface MapUserEntity

setEmailConstraint

public void setEmailConstraint(String emailConstraint)

Specified by:

setEmailConstraint in interface MapUserEntity

getFederationLink

public String getFederationLink()

Specified by:

getFederationLink in interface MapUserEntity

setFederationLink

public void setFederationLink(String federationLink)

Specified by:

setFederationLink in interface MapUserEntity

getServiceAccountClientLink

public String getServiceAccountClientLink()

Specified by:

getServiceAccountClientLink in interface MapUserEntity

setServiceAccountClientLink

public void setServiceAccountClientLink(String serviceAccountClientLink)

Specified by:

setServiceAccountClientLink in interface MapUserEntity

getNotBefore

public Long getNotBefore()

Specified by:

getNotBefore in interface MapUserEntity

setNotBefore

public void setNotBefore(Long notBefore)

Specified by:

setNotBefore in interface MapUserEntity

getGroupsMembership

public Set<String> getGroupsMembership()

Specified by:

getGroupsMembership in interface MapUserEntity

setGroupsMembership

public void setGroupsMembership(Set<String> groupsMembership)

Specified by:

setGroupsMembership in interface MapUserEntity

addGroupsMembership

public void addGroupsMembership(String groupId)

Specified by:

addGroupsMembership in interface MapUserEntity

removeGroupsMembership

public void removeGroupsMembership(String groupId)

Specified by:

removeGroupsMembership in interface MapUserEntity

getRolesMembership

public Set<String> getRolesMembership()

Specified by:

getRolesMembership in interface MapUserEntity

setRolesMembership

public void setRolesMembership(Set<String> rolesMembership)

Specified by:

setRolesMembership in interface MapUserEntity

addRolesMembership

public void addRolesMembership(String roleId)

Specified by:

addRolesMembership in interface MapUserEntity

removeRolesMembership

public void removeRolesMembership(String roleId)

Specified by:

removeRolesMembership in interface MapUserEntity

getRequiredActions

public Set<String> getRequiredActions()

Specified by:

getRequiredActions in interface MapUserEntity

setRequiredActions

public void setRequiredActions(Set<String> requiredActions)

Specified by:

setRequiredActions in interface MapUserEntity

addRequiredAction

public void addRequiredAction(String requiredAction)

Specified by:

addRequiredAction in interface MapUserEntity

removeRequiredAction

public void removeRequiredAction(String requiredAction)

Specified by:

removeRequiredAction in interface MapUserEntity

getAttributes

public Map<String,List<String>> getAttributes()

Specified by:

getAttributes in interface EntityWithAttributes

setAttributes

public void setAttributes(Map<String,List<String>> attributes)

Specified by:

setAttributes in interface EntityWithAttributes

getAttribute

public List<String> getAttribute(String name)

Specified by:

getAttribute in interface EntityWithAttributes

setAttribute

public void setAttribute(String name,
 List<String> values)

Specified by:

setAttribute in interface EntityWithAttributes

removeAttribute

public void removeAttribute(String name)

Specified by:

removeAttribute in interface EntityWithAttributes

getUserConsents

public Set<MapUserConsentEntity> getUserConsents()

Specified by:

getUserConsents in interface MapUserEntity

getUserConsent

public Optional<MapUserConsentEntity> getUserConsent(String clientId)

Specified by:

getUserConsent in interface MapUserEntity

setUserConsents

public void setUserConsents(Set<MapUserConsentEntity> userConsents)

Specified by:

setUserConsents in interface MapUserEntity

addUserConsent

public void addUserConsent(MapUserConsentEntity userConsentEntity)

Specified by:

addUserConsent in interface MapUserEntity

removeUserConsent

public Boolean removeUserConsent(MapUserConsentEntity userConsentEntity)

Specified by:

removeUserConsent in interface MapUserEntity

removeUserConsent

public Boolean removeUserConsent(String clientId)

Specified by:

removeUserConsent in interface MapUserEntity

getCredentials

public List<MapUserCredentialEntity> getCredentials()

Specified by:

getCredentials in interface MapUserEntity

getCredential

public Optional<MapUserCredentialEntity> getCredential(String id)

Specified by:

getCredential in interface MapUserEntity

setCredentials

public void setCredentials(List<MapUserCredentialEntity> credentials)

Specified by:

setCredentials in interface MapUserEntity

addCredential

public void addCredential(MapUserCredentialEntity credentialEntity)

Specified by:

addCredential in interface MapUserEntity

removeCredential

public Boolean removeCredential(MapUserCredentialEntity credentialEntity)

Specified by:

removeCredential in interface MapUserEntity

removeCredential

public Boolean removeCredential(String id)

Specified by:

removeCredential in interface MapUserEntity

getFederatedIdentities

public Set<MapUserFederatedIdentityEntity> getFederatedIdentities()

Specified by:

getFederatedIdentities in interface MapUserEntity

getFederatedIdentity

public Optional<MapUserFederatedIdentityEntity> getFederatedIdentity(String identityProviderId)

Specified by:

getFederatedIdentity in interface MapUserEntity

setFederatedIdentities

public void setFederatedIdentities(Set<MapUserFederatedIdentityEntity> federatedIdentities)

Specified by:

setFederatedIdentities in interface MapUserEntity

addFederatedIdentity

public void addFederatedIdentity(MapUserFederatedIdentityEntity federatedIdentity)

Specified by:

addFederatedIdentity in interface MapUserEntity

removeFederatedIdentity

public Boolean removeFederatedIdentity(MapUserFederatedIdentityEntity federatedIdentity)

Specified by:

removeFederatedIdentity in interface MapUserEntity

removeFederatedIdentity

public Boolean removeFederatedIdentity(String identityProviderId)

Specified by:

removeFederatedIdentity in interface MapUserEntity

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object