Package org.keycloak.models.jpa

Class UserAdapter

java.lang.Object

org.keycloak.models.jpa.UserAdapter

All Implemented Interfaces:

JpaModel<UserEntity>, RoleMapperModel, UserModel

public class UserAdapter
extends Object
implements UserModel, JpaModel<UserEntity>

Version:

$Revision: 1 $

Author:

Bill Burke

Nested Class Summary

Nested classes/interfaces inherited from interface org.keycloak.models.UserModel

UserModel.RequiredAction, UserModel.UserRemovedEvent

Field Summary

Fields

Modifier and Type	Field	Description
protected jakarta.persistence.EntityManager	em
protected RealmModel	realm
protected UserEntity	user

Fields inherited from interface org.keycloak.models.UserModel

COMPARE_BY_USERNAME, DISABLED_REASON, EMAIL, EMAIL_VERIFIED, ENABLED, EXACT, FIRST_NAME, GROUPS, IDP_ALIAS, IDP_USER_ID, INCLUDE_SERVICE_ACCOUNT, LAST_NAME, LOCALE, SEARCH, USERNAME

Constructor Summary

Constructors

Constructor	Description
UserAdapter(KeycloakSession session, RealmModel realm, jakarta.persistence.EntityManager em, UserEntity user)

Method Summary

Modifier and Type	Method	Description
void	addRequiredAction(String actionName)
SubjectCredentialManager	credentialManager()
void	deleteRoleMapping(RoleModel role)
boolean	equals(Object o)
Map<String,List<String>>	getAttributes()
Stream<String>	getAttributeStream(String name)
Stream<RoleModel>	getClientRoleMappingsStream(ClientModel app)
Long	getCreatedTimestamp()
String	getEmail()
UserEntity	getEntity()
String	getFederationLink()
String	getFirstAttribute(String name)
String	getFirstName()
long	getGroupsCount()
long	getGroupsCountByNameContaining(String search)
Stream<GroupModel>	getGroupsStream()
Stream<GroupModel>	getGroupsStream(String search, Integer first, Integer max)
String	getId()
String	getLastName()
Stream<RoleModel>	getRealmRoleMappingsStream()
Stream<String>	getRequiredActionsStream()
Stream<RoleModel>	getRoleMappingsStream()
String	getServiceAccountClientLink()
protected jakarta.persistence.TypedQuery<UserGroupMembershipEntity>	getUserGroupMappingQuery(GroupModel group)
String	getUsername()
protected jakarta.persistence.TypedQuery<UserRoleMappingEntity>	getUserRoleMappingEntityTypedQuery(RoleModel role)
void	grantRole(RoleModel role)
void	grantRoleImpl(RoleModel role)
int	hashCode()
boolean	hasRole(RoleModel role)
boolean	isEmailVerified()
boolean	isEnabled()
boolean	isMemberOf(GroupModel group)
void	joinGroup(GroupModel group)
protected void	joinGroupImpl(GroupModel group)
void	leaveGroup(GroupModel group)
void	removeAttribute(String name)
void	removeRequiredAction(String actionName)
void	setAttribute(String name, List<String> values)
void	setCreatedTimestamp(Long timestamp)
void	setEmail(String email)
void	setEmailVerified(boolean verified)
void	setEnabled(boolean enabled)
void	setFederationLink(String link)
void	setFirstName(String firstName)
void	setLastName(String lastName)
void	setServiceAccountClientLink(String clientInternalId)
void	setSingleAttribute(String name, String value)
void	setUsername(String username)

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.keycloak.models.RoleMapperModel

hasDirectRole

Methods inherited from interface org.keycloak.models.UserModel

addRequiredAction, removeRequiredAction

Field Details

user

protected UserEntity user

em

protected jakarta.persistence.EntityManager em

realm

protected RealmModel realm

Constructor Details

UserAdapter

public UserAdapter(KeycloakSession session,
 RealmModel realm,
 jakarta.persistence.EntityManager em,
 UserEntity user)

Method Details

getEntity

public UserEntity getEntity()

Specified by:

getEntity in interface JpaModel<UserEntity>

getId

public String getId()

Specified by:

getId in interface UserModel

getUsername

public String getUsername()

Specified by:

getUsername in interface UserModel

setUsername

public void setUsername(String username)

Specified by:

setUsername in interface UserModel

getCreatedTimestamp

public Long getCreatedTimestamp()

Specified by:

getCreatedTimestamp in interface UserModel

setCreatedTimestamp

public void setCreatedTimestamp(Long timestamp)

Specified by:

setCreatedTimestamp in interface UserModel

isEnabled

public boolean isEnabled()

Specified by:

isEnabled in interface UserModel

setEnabled

public void setEnabled(boolean enabled)

Specified by:

setEnabled in interface UserModel

setSingleAttribute

public void setSingleAttribute(String name,
 String value)

Specified by:

setSingleAttribute in interface UserModel

setAttribute

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

Specified by:

setAttribute in interface UserModel

removeAttribute

public void removeAttribute(String name)

Specified by:

removeAttribute in interface UserModel

getFirstAttribute

public String getFirstAttribute(String name)

Specified by:

getFirstAttribute in interface UserModel

getAttributeStream

public Stream<String> getAttributeStream(String name)

Specified by:

getAttributeStream in interface UserModel

getAttributes

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

Specified by:

getAttributes in interface UserModel

getRequiredActionsStream

public Stream<String> getRequiredActionsStream()

Specified by:

getRequiredActionsStream in interface UserModel

addRequiredAction

public void addRequiredAction(String actionName)

Specified by:

addRequiredAction in interface UserModel

removeRequiredAction

public void removeRequiredAction(String actionName)

Specified by:

removeRequiredAction in interface UserModel

getFirstName

public String getFirstName()

Specified by:

getFirstName in interface UserModel

setFirstName

public void setFirstName(String firstName)

Specified by:

setFirstName in interface UserModel

getLastName

public String getLastName()

Specified by:

getLastName in interface UserModel

setLastName

public void setLastName(String lastName)

Specified by:

setLastName in interface UserModel

getEmail

public String getEmail()

Specified by:

getEmail in interface UserModel

setEmail

public void setEmail(String email)

Specified by:

setEmail in interface UserModel

isEmailVerified

public boolean isEmailVerified()

Specified by:

isEmailVerified in interface UserModel

setEmailVerified

public void setEmailVerified(boolean verified)

Specified by:

setEmailVerified in interface UserModel

getGroupsStream

public Stream<GroupModel> getGroupsStream()

Specified by:

getGroupsStream in interface UserModel

getGroupsStream

public Stream<GroupModel> getGroupsStream(String search,
 Integer first,
 Integer max)

Specified by:

getGroupsStream in interface UserModel

getGroupsCount

public long getGroupsCount()

Specified by:

getGroupsCount in interface UserModel

getGroupsCountByNameContaining

public long getGroupsCountByNameContaining(String search)

Specified by:

getGroupsCountByNameContaining in interface UserModel

joinGroup

public void joinGroup(GroupModel group)

Specified by:

joinGroup in interface UserModel

joinGroupImpl

protected void joinGroupImpl(GroupModel group)

leaveGroup

public void leaveGroup(GroupModel group)

Specified by:

leaveGroup in interface UserModel

isMemberOf

public boolean isMemberOf(GroupModel group)

Specified by:

isMemberOf in interface UserModel

getUserGroupMappingQuery

protected jakarta.persistence.TypedQuery<UserGroupMembershipEntity> getUserGroupMappingQuery(GroupModel group)

hasRole

public boolean hasRole(RoleModel role)

Specified by:

hasRole in interface RoleMapperModel

getUserRoleMappingEntityTypedQuery

protected jakarta.persistence.TypedQuery<UserRoleMappingEntity> getUserRoleMappingEntityTypedQuery(RoleModel role)

grantRole

public void grantRole(RoleModel role)

Specified by:

grantRole in interface RoleMapperModel

grantRoleImpl

public void grantRoleImpl(RoleModel role)

getRealmRoleMappingsStream

public Stream<RoleModel> getRealmRoleMappingsStream()

Specified by:

getRealmRoleMappingsStream in interface RoleMapperModel

getRoleMappingsStream

public Stream<RoleModel> getRoleMappingsStream()

Specified by:

getRoleMappingsStream in interface RoleMapperModel

deleteRoleMapping

public void deleteRoleMapping(RoleModel role)

Specified by:

deleteRoleMapping in interface RoleMapperModel

getClientRoleMappingsStream

public Stream<RoleModel> getClientRoleMappingsStream(ClientModel app)

Specified by:

getClientRoleMappingsStream in interface RoleMapperModel

getFederationLink

public String getFederationLink()

Specified by:

getFederationLink in interface UserModel

setFederationLink

public void setFederationLink(String link)

Specified by:

setFederationLink in interface UserModel

getServiceAccountClientLink

public String getServiceAccountClientLink()

Specified by:

getServiceAccountClientLink in interface UserModel

setServiceAccountClientLink

public void setServiceAccountClientLink(String clientInternalId)

Specified by:

setServiceAccountClientLink in interface UserModel

credentialManager

public SubjectCredentialManager credentialManager()

Specified by:

credentialManager in interface UserModel

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object