public class UserAdapter extends Object implements UserModel.Streams, JpaModel<UserEntity>
UserModel.RequiredAction, UserModel.Streams, UserModel.UserRemovedEvent| Modifier and Type | Field and Description |
|---|---|
protected javax.persistence.EntityManager |
em |
protected RealmModel |
realm |
protected UserEntity |
user |
COMPARE_BY_USERNAME, 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, waitgetAttribute, getGroups, getRequiredActionsaddRequiredAction, getGroups, getGroups, removeRequiredActiongetClientRoleMappings, getRealmRoleMappings, getRoleMappingsprotected 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 UserModelpublic void setUsername(String username)
UserModelsetUsername in interface UserModelusername - username stringpublic Long getCreatedTimestamp()
UserModelgetCreatedTimestamp in interface UserModelpublic void setCreatedTimestamp(Long timestamp)
setCreatedTimestamp in interface UserModelpublic void setEnabled(boolean enabled)
setEnabled in interface UserModelpublic void setSingleAttribute(String name, String value)
UserModelsetSingleAttribute in interface UserModelpublic void setAttribute(String name, List<String> values)
setAttribute in interface UserModelpublic void removeAttribute(String name)
removeAttribute in interface UserModelpublic String getFirstAttribute(String name)
getFirstAttribute in interface UserModelpublic Stream<String> getAttributeStream(String name)
UserModelgetAttributeStream in interface UserModelgetAttributeStream in interface UserModel.Streamsname - the name of the attribute.Stream of attribute values.public Map<String,List<String>> getAttributes()
getAttributes in interface UserModelpublic Stream<String> getRequiredActionsStream()
UserModelgetRequiredActionsStream in interface UserModelgetRequiredActionsStream in interface UserModel.StreamsStream of required action names.public void addRequiredAction(String actionName)
addRequiredAction in interface UserModelpublic void removeRequiredAction(String actionName)
removeRequiredAction in interface UserModelpublic String getFirstName()
getFirstName in interface UserModelpublic void setFirstName(String firstName)
setFirstName in interface UserModelpublic String getLastName()
getLastName in interface UserModelpublic void setLastName(String lastName)
setLastName in interface UserModelpublic void setEmail(String email)
UserModelpublic boolean isEmailVerified()
isEmailVerified in interface UserModelpublic void setEmailVerified(boolean verified)
setEmailVerified in interface UserModelpublic Stream<GroupModel> getGroupsStream()
UserModelgetGroupsStream in interface UserModelgetGroupsStream in interface UserModel.StreamsStream of groups.public Stream<GroupModel> getGroupsStream(String search, Integer first, Integer max)
UserModelgetGroupsStream in interface UserModelsearch - 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.public long getGroupsCount()
getGroupsCount in interface UserModelpublic long getGroupsCountByNameContaining(String search)
getGroupsCountByNameContaining in interface UserModelpublic void joinGroup(GroupModel group)
protected void joinGroupImpl(GroupModel group)
public void leaveGroup(GroupModel group)
leaveGroup in interface UserModelpublic boolean isMemberOf(GroupModel group)
isMemberOf in interface UserModelprotected javax.persistence.TypedQuery<UserGroupMembershipEntity> getUserGroupMappingQuery(GroupModel group)
public boolean hasRole(RoleModel role)
RoleMapperModeltrue 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 RoleMapperModelprotected javax.persistence.TypedQuery<UserRoleMappingEntity> getUserRoleMappingEntityTypedQuery(RoleModel role)
public void grantRole(RoleModel role)
RoleMapperModelgrantRole in interface RoleMapperModelpublic void grantRoleImpl(RoleModel role)
public Stream<RoleModel> getRealmRoleMappingsStream()
RoleMapperModelgetRealmRoleMappingsStream in interface RoleMapperModelgetRealmRoleMappingsStream in interface RoleMapperModel.StreamsRoleModelpublic Stream<RoleModel> getRoleMappingsStream()
RoleMapperModelgetRoleMappingsStream in interface RoleMapperModelgetRoleMappingsStream in interface RoleMapperModel.StreamsRoleModelpublic void deleteRoleMapping(RoleModel role)
RoleMapperModeldeleteRoleMapping in interface RoleMapperModelrole - Role to removepublic Stream<RoleModel> getClientRoleMappingsStream(ClientModel app)
RoleMapperModelgetClientRoleMappingsStream in interface RoleMapperModelgetClientRoleMappingsStream in interface RoleMapperModel.Streamsapp - Client to get the roles forRoleModelpublic String getFederationLink()
getFederationLink in interface UserModelpublic void setFederationLink(String link)
setFederationLink in interface UserModelpublic String getServiceAccountClientLink()
getServiceAccountClientLink in interface UserModelpublic void setServiceAccountClientLink(String clientInternalId)
setServiceAccountClientLink in interface UserModelCopyright © 2021 JBoss by Red Hat. All rights reserved.