public class UserAdapter extends Object implements UserModel.Streams, JpaModel<UserEntity>
UserModel.RequiredAction, UserModel.SearchableFields, UserModel.Streams, UserModel.UserRemovedEvent
Modifier and Type | Field and Description |
---|---|
protected javax.persistence.EntityManager |
em |
protected RealmModel |
realm |
protected UserEntity |
user |
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 and Description |
---|
UserAdapter(KeycloakSession session,
RealmModel realm,
javax.persistence.EntityManager em,
UserEntity user) |
Modifier and Type | Method and Description |
---|---|
void |
addRequiredAction(String actionName) |
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 names 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 javax.persistence.TypedQuery<UserGroupMembershipEntity> |
getUserGroupMappingQuery(GroupModel group) |
String |
getUsername() |
protected javax.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) |
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)
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.
|
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
getAttribute, getGroups, getRequiredActions
addRequiredAction, getGroups, getGroups, removeRequiredAction
getClientRoleMappings, getRealmRoleMappings, getRoleMappings
protected UserEntity user
protected javax.persistence.EntityManager em
protected RealmModel realm
public UserAdapter(KeycloakSession session, RealmModel realm, javax.persistence.EntityManager em, UserEntity user)
public UserEntity getEntity()
getEntity
in interface JpaModel<UserEntity>
public String getUsername()
getUsername
in interface UserModel
public void setUsername(String username)
UserModel
setUsername
in interface UserModel
username
- username stringpublic Long getCreatedTimestamp()
UserModel
getCreatedTimestamp
in interface UserModel
public void setCreatedTimestamp(Long timestamp)
setCreatedTimestamp
in interface UserModel
public void setEnabled(boolean enabled)
setEnabled
in interface UserModel
public void setSingleAttribute(String name, String value)
UserModel
setSingleAttribute
in interface UserModel
public void setAttribute(String name, List<String> values)
setAttribute
in interface UserModel
public void removeAttribute(String name)
removeAttribute
in interface UserModel
public String getFirstAttribute(String name)
getFirstAttribute
in interface UserModel
public Stream<String> getAttributeStream(String name)
UserModel
getAttributeStream
in interface UserModel
getAttributeStream
in interface UserModel.Streams
name
- the name of the attribute.Stream
of attribute values.public Map<String,List<String>> getAttributes()
getAttributes
in interface UserModel
public Stream<String> getRequiredActionsStream()
UserModel
getRequiredActionsStream
in interface UserModel
getRequiredActionsStream
in interface UserModel.Streams
Stream
of required action names.public void addRequiredAction(String actionName)
addRequiredAction
in interface UserModel
public void removeRequiredAction(String actionName)
removeRequiredAction
in interface UserModel
public String getFirstName()
getFirstName
in interface UserModel
public void setFirstName(String firstName)
setFirstName
in interface UserModel
public String getLastName()
getLastName
in interface UserModel
public void setLastName(String lastName)
setLastName
in interface UserModel
public void setEmail(String email)
UserModel
public boolean isEmailVerified()
isEmailVerified
in interface UserModel
public void setEmailVerified(boolean verified)
setEmailVerified
in interface UserModel
public Stream<GroupModel> getGroupsStream()
UserModel
getGroupsStream
in interface UserModel
getGroupsStream
in interface UserModel.Streams
Stream
of groups.public Stream<GroupModel> getGroupsStream(String search, Integer first, Integer max)
UserModel
getGroupsStream
in interface UserModel
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
.null
.public long getGroupsCount()
getGroupsCount
in interface UserModel
public long getGroupsCountByNameContaining(String search)
getGroupsCountByNameContaining
in interface UserModel
public void joinGroup(GroupModel group)
protected void joinGroupImpl(GroupModel group)
public void leaveGroup(GroupModel group)
leaveGroup
in interface UserModel
public boolean isMemberOf(GroupModel group)
isMemberOf
in interface UserModel
protected javax.persistence.TypedQuery<UserGroupMembershipEntity> getUserGroupMappingQuery(GroupModel group)
public boolean hasRole(RoleModel role)
RoleMapperModel
true
if this object is directly or indirectly assigned the given role, false
otherwise.
For example, true
is returned for hasRole(R) if:
hasRole
in interface RoleMapperModel
protected javax.persistence.TypedQuery<UserRoleMappingEntity> getUserRoleMappingEntityTypedQuery(RoleModel role)
public void grantRole(RoleModel role)
RoleMapperModel
grantRole
in interface RoleMapperModel
public void grantRoleImpl(RoleModel role)
public Stream<RoleModel> getRealmRoleMappingsStream()
RoleMapperModel
getRealmRoleMappingsStream
in interface RoleMapperModel
getRealmRoleMappingsStream
in interface RoleMapperModel.Streams
RoleModel
. Never returns null
.public Stream<RoleModel> getRoleMappingsStream()
RoleMapperModel
getRoleMappingsStream
in interface RoleMapperModel
getRoleMappingsStream
in interface RoleMapperModel.Streams
RoleModel
. Never returns null
.public void deleteRoleMapping(RoleModel role)
RoleMapperModel
deleteRoleMapping
in interface RoleMapperModel
role
- Role to removepublic Stream<RoleModel> getClientRoleMappingsStream(ClientModel app)
RoleMapperModel
getClientRoleMappingsStream
in interface RoleMapperModel
getClientRoleMappingsStream
in interface RoleMapperModel.Streams
app
- ClientModel
Client to get the roles for.RoleModel
. Never returns null
.public String getFederationLink()
getFederationLink
in interface UserModel
public void setFederationLink(String link)
setFederationLink
in interface UserModel
public String getServiceAccountClientLink()
getServiceAccountClientLink
in interface UserModel
public void setServiceAccountClientLink(String clientInternalId)
setServiceAccountClientLink
in interface UserModel
Copyright © 2021 JBoss by Red Hat. All rights reserved.