public abstract class AbstractUserAdapter extends Object implements UserModel
| Modifier and Type | Class and Description |
|---|---|
static class |
AbstractUserAdapter.ReadOnlyException |
UserModel.RequiredAction, UserModel.UserRemovedEvent| Modifier and Type | Field and Description |
|---|---|
protected long |
created |
protected RealmModel |
realm |
protected KeycloakSession |
session |
protected StorageId |
storageId |
protected ComponentModel |
storageProviderModel |
| Constructor and Description |
|---|
AbstractUserAdapter(KeycloakSession session,
RealmModel realm,
ComponentModel storageProviderModel) |
| Modifier and Type | Method and Description |
|---|---|
void |
addRequiredAction(String action) |
void |
addRequiredAction(UserModel.RequiredAction action) |
protected boolean |
appendDefaultGroups()
Should the realm's default groups be appended to getGroups() call?
If your storage provider is not managing group mappings then it is recommended that
this method return true
|
protected boolean |
appendDefaultRolesToRoleMappings()
Should the realm's default roles be appended to getRoleMappings() call?
If your storage provider is not managing all role mappings then it is recommended that
this method return true
|
void |
deleteRoleMapping(RoleModel role) |
boolean |
equals(Object o) |
List<String> |
getAttribute(String name) |
Map<String,List<String>> |
getAttributes() |
Set<RoleModel> |
getClientRoleMappings(ClientModel app) |
Long |
getCreatedTimestamp()
Get timestamp of user creation.
|
List<UserCredentialValueModel> |
getCredentialsDirectly() |
String |
getEmail() |
String |
getFederationLink()
This method should not be overriden
|
String |
getFirstAttribute(String name) |
String |
getFirstName() |
Set<GroupModel> |
getGroups() |
protected Set<GroupModel> |
getGroupsInternal()
Get group membership mappings that are managed by this storage provider
|
String |
getId()
Defaults to 'f:' + storageProvider.getId() + ':' + getUsername()
|
String |
getLastName() |
Set<RoleModel> |
getRealmRoleMappings() |
Set<String> |
getRequiredActions() |
Set<RoleModel> |
getRoleMappings() |
protected Set<RoleModel> |
getRoleMappingsInternal() |
String |
getServiceAccountClientLink()
This method should not be overriden
|
void |
grantRole(RoleModel role) |
int |
hashCode() |
boolean |
hasRole(RoleModel role) |
boolean |
isEmailVerified() |
boolean |
isEnabled() |
boolean |
isMemberOf(GroupModel group) |
boolean |
isOtpEnabled() |
void |
joinGroup(GroupModel group) |
void |
leaveGroup(GroupModel group) |
void |
removeAttribute(String name) |
void |
removeRequiredAction(String action) |
void |
removeRequiredAction(UserModel.RequiredAction action) |
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)
This method should not be overriden
|
void |
setFirstName(String firstName) |
void |
setLastName(String lastName) |
void |
setOtpEnabled(boolean totp) |
void |
setServiceAccountClientLink(String clientInternalId)
This method should not be overriden
|
void |
setSingleAttribute(String name,
String value)
Set single value of specified attribute.
|
void |
setUsername(String username) |
void |
updateCredential(UserCredentialModel cred) |
void |
updateCredentialDirectly(UserCredentialValueModel cred) |
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, waitgetUsernameprotected KeycloakSession session
protected RealmModel realm
protected ComponentModel storageProviderModel
protected StorageId storageId
protected long created
public AbstractUserAdapter(KeycloakSession session, RealmModel realm, ComponentModel storageProviderModel)
public Set<String> getRequiredActions()
getRequiredActions in interface UserModelpublic void addRequiredAction(String action)
addRequiredAction in interface UserModelpublic void removeRequiredAction(String action)
removeRequiredAction in interface UserModelpublic void addRequiredAction(UserModel.RequiredAction action)
addRequiredAction in interface UserModelpublic void removeRequiredAction(UserModel.RequiredAction action)
removeRequiredAction in interface UserModelprotected Set<GroupModel> getGroupsInternal()
protected boolean appendDefaultGroups()
public Set<GroupModel> getGroups()
public void joinGroup(GroupModel group)
public void leaveGroup(GroupModel group)
leaveGroup in interface UserModelpublic boolean isMemberOf(GroupModel group)
isMemberOf in interface UserModelpublic Set<RoleModel> getRealmRoleMappings()
getRealmRoleMappings in interface RoleMapperModelpublic Set<RoleModel> getClientRoleMappings(ClientModel app)
getClientRoleMappings in interface RoleMapperModelpublic boolean hasRole(RoleModel role)
hasRole in interface RoleMapperModelpublic void grantRole(RoleModel role)
grantRole in interface RoleMapperModelprotected boolean appendDefaultRolesToRoleMappings()
public Set<RoleModel> getRoleMappings()
getRoleMappings in interface RoleMapperModelpublic void deleteRoleMapping(RoleModel role)
deleteRoleMapping in interface RoleMapperModelpublic void setEnabled(boolean enabled)
setEnabled in interface UserModelpublic boolean isOtpEnabled()
isOtpEnabled in interface UserModelpublic void setOtpEnabled(boolean totp)
setOtpEnabled in interface UserModelpublic 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 UserModelpublic String getId()
public void setUsername(String username)
setUsername in interface UserModelpublic Long getCreatedTimestamp()
UserModelgetCreatedTimestamp in interface UserModelpublic void setCreatedTimestamp(Long timestamp)
setCreatedTimestamp in interface UserModelpublic void setSingleAttribute(String name, String value)
UserModelsetSingleAttribute in interface UserModelpublic void removeAttribute(String name)
removeAttribute in interface UserModelpublic void setAttribute(String name, List<String> values)
setAttribute in interface UserModelpublic String getFirstAttribute(String name)
getFirstAttribute in interface UserModelpublic Map<String,List<String>> getAttributes()
getAttributes in interface UserModelpublic List<String> getAttribute(String name)
getAttribute 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 boolean isEmailVerified()
isEmailVerified in interface UserModelpublic void setEmailVerified(boolean verified)
setEmailVerified in interface UserModelpublic void updateCredential(UserCredentialModel cred)
updateCredential in interface UserModelpublic List<UserCredentialValueModel> getCredentialsDirectly()
getCredentialsDirectly in interface UserModelpublic void updateCredentialDirectly(UserCredentialValueModel cred)
updateCredentialDirectly in interface UserModelCopyright © 2016 JBoss by Red Hat. All rights reserved.