Package org.keycloak.models.map.user

Class MapUserAdapter

java.lang.Object

org.keycloak.models.map.user.AbstractUserModel<MapUserEntity>

org.keycloak.models.map.user.MapUserAdapter

All Implemented Interfaces:

RoleMapperModel, UserModel

public abstract class MapUserAdapter
extends AbstractUserModel<MapUserEntity>

Nested Class Summary

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

UserModel.RequiredAction, UserModel.SearchableFields, UserModel.Streams, UserModel.UserRemovedEvent

Field Summary

Fields inherited from class org.keycloak.models.map.user.AbstractUserModel

entity, realm, session

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
MapUserAdapter(KeycloakSession session, RealmModel realm, MapUserEntity entity)

Method Summary

Modifier and Type	Method	Description
void	addRequiredAction(String action)
abstract boolean	checkEmailUniqueness(RealmModel realm, String email)
abstract boolean	checkUsernameUniqueness(RealmModel realm, String username)
void	deleteRoleMapping(RoleModel role)
Map<String,List<String>>	getAttributes()
Stream<String>	getAttributeStream(String name)
Stream<RoleModel>	getClientRoleMappingsStream(ClientModel app)
Long	getCreatedTimestamp()
String	getEmail()
String	getFederationLink()
String	getFirstAttribute(String name)
String	getFirstName()
Stream<GroupModel>	getGroupsStream()
String	getId()
String	getLastName()
Stream<RoleModel>	getRealmRoleMappingsStream()
Stream<String>	getRequiredActionsStream()
Stream<RoleModel>	getRoleMappingsStream()
String	getServiceAccountClientLink()
String	getUsername()
void	grantRole(RoleModel role)
boolean	hasDirectRole(RoleModel role)
boolean	hasRole(RoleModel role)
boolean	isEmailVerified()
boolean	isEnabled()
boolean	isMemberOf(GroupModel group)
void	joinGroup(GroupModel group)
void	leaveGroup(GroupModel group)
void	removeAttribute(String name)
void	removeRequiredAction(String 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)
void	setFirstName(String firstName)
void	setLastName(String lastName)
void	setServiceAccountClientLink(String clientInternalId)
void	setSingleAttribute(String name, String value)
void	setUsername(String username)
String	toString()

Methods inherited from class org.keycloak.models.map.user.AbstractUserModel

equals, hashCode

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.keycloak.models.UserModel

addRequiredAction, credentialManager, getGroupsCount, getGroupsCountByNameContaining, getGroupsStream, removeRequiredAction

Constructor Detail

MapUserAdapter

public MapUserAdapter(KeycloakSession session,
                      RealmModel realm,
                      MapUserEntity entity)

Method Detail

getId

public String getId()

getUsername

public String getUsername()

Returns:

username. Letter case is determined by a realm setting.

setUsername

public void setUsername(String username)

getCreatedTimestamp

public Long getCreatedTimestamp()

setCreatedTimestamp

public void setCreatedTimestamp(Long timestamp)

isEnabled

public boolean isEnabled()

setEnabled

public void setEnabled(boolean enabled)

setSingleAttribute

public void setSingleAttribute(String name,
                               String value)

setAttribute

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

removeAttribute

public void removeAttribute(String name)

getFirstAttribute

public String getFirstAttribute(String name)

getAttributeStream

public Stream<String> getAttributeStream(String name)

getAttributes

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

getRequiredActionsStream

public Stream<String> getRequiredActionsStream()

addRequiredAction

public void addRequiredAction(String action)

removeRequiredAction

public void removeRequiredAction(String action)

getFirstName

public String getFirstName()

setFirstName

public void setFirstName(String firstName)

getLastName

public String getLastName()

setLastName

public void setLastName(String lastName)

getEmail

public String getEmail()

setEmail

public void setEmail(String email)

checkEmailUniqueness

public abstract boolean checkEmailUniqueness(RealmModel realm,
                                             String email)

checkUsernameUniqueness

public abstract boolean checkUsernameUniqueness(RealmModel realm,
                                                String username)

isEmailVerified

public boolean isEmailVerified()

setEmailVerified

public void setEmailVerified(boolean verified)

getGroupsStream

public Stream<GroupModel> getGroupsStream()

joinGroup

public void joinGroup(GroupModel group)

leaveGroup

public void leaveGroup(GroupModel group)

isMemberOf

public boolean isMemberOf(GroupModel group)

getFederationLink

public String getFederationLink()

setFederationLink

public void setFederationLink(String link)

getServiceAccountClientLink

public String getServiceAccountClientLink()

setServiceAccountClientLink

public void setServiceAccountClientLink(String clientInternalId)

getRealmRoleMappingsStream

public Stream<RoleModel> getRealmRoleMappingsStream()

getClientRoleMappingsStream

public Stream<RoleModel> getClientRoleMappingsStream(ClientModel app)

hasDirectRole

public boolean hasDirectRole(RoleModel role)

hasRole

public boolean hasRole(RoleModel role)

grantRole

public void grantRole(RoleModel role)

getRoleMappingsStream

public Stream<RoleModel> getRoleMappingsStream()

deleteRoleMapping

public void deleteRoleMapping(RoleModel role)

toString

public String toString()

Overrides:

toString in class Object