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.UserPreRemovedEvent, 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_PENDING, EMAIL_VERIFIED, ENABLED, EXACT, FIRST_NAME, GROUPS, IDP_ALIAS, IDP_USER_ID, INCLUDE_SERVICE_ACCOUNT, IS_TEMP_ADMIN_ATTR_NAME, 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()	Instance of a user credential manager to validate and update the credentials of this user.
void	deleteRoleMapping(RoleModel role)	Removes the given role mapping from this object.
boolean	equals(Object o)
Map<String,List<String>>	getAttributes()
Stream<String>	getAttributeStream(String name)	Obtains all values associated with the specified attribute name.
Stream<RoleModel>	getClientRoleMappingsStream(ClientModel app)	Returns stream of client roles that are directly set to this object for the given client.
Long	getCreatedTimestamp()	Get timestamp of user creation.
String	getEmail()
UserEntity	getEntity()
String	getFederationLink()
String	getFirstAttribute(String name)
String	getFirstName()
long	getGroupsCount()
long	getGroupsCountByNameContaining(String search)
Stream<GroupModel>	getGroupsStream()	Obtains the groups associated with the user.
Stream<GroupModel>	getGroupsStream(String search, Integer first, Integer max)	Returns a paginated stream of groups within this realm with search in the name
String	getId()
String	getLastName()
Stream<RoleModel>	getRealmRoleMappingsStream()	Returns stream of realm roles that are directly set to this object.
Stream<String>	getRequiredActionsStream()	Obtains the aliases of required actions associated with the user.
Stream<RoleModel>	getRoleMappingsStream()	Returns stream of all role (both realm all client) that are directly set to this object.
String	getServiceAccountClientLink()
protected jakarta.persistence.TypedQuery<UserGroupMembershipEntity>	getUserGroupMappingQuery(GroupModel group)
String	getUsername()
protected jakarta.persistence.TypedQuery<UserRoleMappingEntity>	getUserRoleMappingEntityTypedQuery(RoleModel role)
void	grantRole(RoleModel role)	Grants the given role to this object.
void	grantRoleImpl(RoleModel role)
int	hashCode()
boolean	hasRole(RoleModel role)	Returns true if this object is directly or indirectly assigned the given role, false otherwise.
boolean	isEmailVerified()
boolean	isEnabled()
boolean	isMemberOf(GroupModel group)
void	joinGroup(GroupModel group)
void	joinGroup(GroupModel group, MembershipMetadata metadata)
protected void	joinGroupImpl(GroupModel group)
protected void	joinGroupImpl(GroupModel group, MembershipMetadata metadata)
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)	Sets email for this user.
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)	Set single value of specified attribute.
void	setUsername(String username)	Sets username for this user.

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, isFederated, 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)

Description copied from interface: UserModel

Sets username for this user. No default method here to allow Abstract subclasses where the username is provided in a different manner

Specified by:

setUsername in interface UserModel

Parameters:

username - username string

getCreatedTimestamp

public Long getCreatedTimestamp()

Description copied from interface: UserModel

Get timestamp of user creation. May be null for old users created before this feature introduction.

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)

Description copied from interface: UserModel

Set single value of specified attribute. Remove all other existing values of this attribute

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

Returns:

null if there is not any value of specified attribute or first value otherwise. Don't throw exception if there are more values of the attribute

getAttributeStream

public Stream<String> getAttributeStream(String name)

Description copied from interface: UserModel

Obtains all values associated with the specified attribute name.

Specified by:

getAttributeStream in interface UserModel

Parameters:

name - the name of the attribute.

Returns:

a non-null Stream of attribute values.

getAttributes

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

Specified by:

getAttributes in interface UserModel

getRequiredActionsStream

public Stream<String> getRequiredActionsStream()

Description copied from interface: UserModel

Obtains the aliases of required actions associated with the user.

Specified by:

getRequiredActionsStream in interface UserModel

Returns:

a non-null Stream of required action aliases.

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)

Description copied from interface: UserModel

Sets email for this user.

Specified by:

setEmail in interface UserModel

Parameters:

email - the email

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()

Description copied from interface: UserModel

Obtains the groups associated with the user.

Specified by:

getGroupsStream in interface UserModel

Returns:

a non-null Stream of groups.

getGroupsStream

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

Description copied from interface: UserModel

Returns a paginated stream of groups within this realm with search in the name

Specified by:

getGroupsStream in interface UserModel

Parameters:

search - Case insensitive string which will be searched for. Ignored if null.

first - Index of first group to return. Ignored if negative or null.

max - Maximum number of records to return. Ignored if negative or null.

Returns:

Stream of desired groups. Never returns null.

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

joinGroup

public void joinGroup(GroupModel group,
 MembershipMetadata metadata)

Specified by:

joinGroup in interface UserModel

joinGroupImpl

protected void joinGroupImpl(GroupModel group)

joinGroupImpl

protected void joinGroupImpl(GroupModel group,
 MembershipMetadata metadata)

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)

Description copied from interface: RoleMapperModel

Returns true if this object is directly or indirectly assigned the given role, false otherwise.

For example, true is returned for hasRole(R) if:

• R is directly assigned to this object
• R is indirectly assigned to this object via composites
• R is not assigned to this object but this object belongs to a group G which is assigned the role R
• R is not assigned to this object but this object belongs to a group G, and G belongs to group H which is assigned the role R

Specified by:

hasRole in interface RoleMapperModel

Returns:

see description

See Also:

• if you want to check if this object is directly assigned to a role

getUserRoleMappingEntityTypedQuery

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

grantRole

public void grantRole(RoleModel role)

Description copied from interface: RoleMapperModel

Grants the given role to this object.

Specified by:

grantRole in interface RoleMapperModel

grantRoleImpl

public void grantRoleImpl(RoleModel role)

getRealmRoleMappingsStream

public Stream<RoleModel> getRealmRoleMappingsStream()

Description copied from interface: RoleMapperModel

Returns stream of realm roles that are directly set to this object.

Specified by:

getRealmRoleMappingsStream in interface RoleMapperModel

Returns:

Stream of RoleModel. Never returns null.

getRoleMappingsStream

public Stream<RoleModel> getRoleMappingsStream()

Description copied from interface: RoleMapperModel

Returns stream of all role (both realm all client) that are directly set to this object.

Specified by:

getRoleMappingsStream in interface RoleMapperModel

Returns:

Stream of RoleModel. Never returns null.

deleteRoleMapping

public void deleteRoleMapping(RoleModel role)

Description copied from interface: RoleMapperModel

Removes the given role mapping from this object.

Specified by:

deleteRoleMapping in interface RoleMapperModel

Parameters:

role - Role to remove

getClientRoleMappingsStream

public Stream<RoleModel> getClientRoleMappingsStream(ClientModel app)

Description copied from interface: RoleMapperModel

Returns stream of client roles that are directly set to this object for the given client.

Specified by:

getClientRoleMappingsStream in interface RoleMapperModel

Parameters:

app - ClientModel Client to get the roles for.

Returns:

Stream of RoleModel. Never returns null.

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()

Description copied from interface: UserModel

Instance of a user credential manager to validate and update the credentials of this user.

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