Package org.keycloak.models.light

Class LightweightUserAdapter

java.lang.Object

org.keycloak.models.UserModelDefaultMethods

org.keycloak.storage.adapter.AbstractInMemoryUserAdapter

org.keycloak.models.light.LightweightUserAdapter

All Implemented Interfaces:

Model, RoleMapperModel, UserModel

public class LightweightUserAdapter
extends AbstractInMemoryUserAdapter

Author:

hmlnarik

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
static final String	ID_PREFIX

Fields inherited from class org.keycloak.storage.adapter.AbstractInMemoryUserAdapter

id, realm, session

Fields inherited from interface org.keycloak.models.UserModel

COMPARE_BY_USERNAME, CREATED_TIMESTAMP, DID, DISABLED_REASON, EMAIL, EMAIL_PENDING, EMAIL_VERIFIED, ENABLED, EXACT, FIRST_NAME, GROUPS, ID, IDP_ALIAS, IDP_USER_ID, INCLUDE_SERVICE_ACCOUNT, IS_TEMP_ADMIN_ATTR_NAME, LAST_NAME, LOCALE, SEARCH, USERNAME

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	LightweightUserAdapter()
	LightweightUserAdapter(KeycloakSession session, String id)
	LightweightUserAdapter(KeycloakSession session, RealmModel realm, String id)

Method Summary

Modifier and Type	Method	Description
void	addConsent(UserConsentModel consent)
void	addDefaults()
void	addRequiredAction(String action)
void	addRequiredAction(UserModel.RequiredAction action)
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.
static LightweightUserAdapter	fromString(KeycloakSession session, RealmModel realm, String serializedForm)
UserConsentModel	getConsentByClient(String clientInternalId)
Stream<UserConsentModel>	getConsentsStream()
static String	getLightweightUserId(String id)
void	grantRole(RoleModel role)	Grants the given role to this object.
static boolean	isLightweightUser(String id)
static boolean	isLightweightUser(UserModel user)
void	joinGroup(GroupModel group)
void	leaveGroup(GroupModel group)
void	removeAttribute(String name)
void	removeRequiredAction(String action)
void	removeRequiredAction(UserModel.RequiredAction action)
boolean	revokeConsentForClient(String clientInternalId)
String	serialize()
void	setAttribute(String name, List<String> values)
void	setCreatedTimestamp(Long timestamp)
void	setEmailVerified(boolean verified)
void	setEnabled(boolean enabled)
void	setFederationLink(String link)
void	setOwningUserSessionId(String id)
void	setReadonly(boolean flag)
void	setServiceAccountClientLink(String clientInternalId)
void	setSingleAttribute(String name, String value)	Set single value of specified attribute.
void	setUpdateHandler(Consumer<LightweightUserAdapter> updateHandler)
void	setUsername(String username)	Sets username for this user.
void	updateConsent(UserConsentModel consent)

Methods inherited from class org.keycloak.storage.adapter.AbstractInMemoryUserAdapter

checkReadonly, equals, getAttributes, getAttributeStream, getClientRoleMappingsStream, getCreatedTimestamp, getFederationLink, getFirstAttribute, getGroupsStream, getId, getRealmRoleMappingsStream, getRequiredActionsStream, getRoleMappingsStream, getServiceAccountClientLink, getUsername, hashCode, hasRole, isEmailVerified, isEnabled, isMemberOf

Methods inherited from class org.keycloak.models.UserModelDefaultMethods

getEmail, getFirstName, getLastName, setEmail, setFirstName, setLastName, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.keycloak.models.RoleMapperModel

hasDirectRole

Methods inherited from interface org.keycloak.models.UserModel

getGroupsCount, getGroupsCountByNameContaining, getGroupsStream, getLastModifiedTimestamp, isFederated, joinGroup, setLastModifiedTimestamp

Field Details

ID_PREFIX

public static final String ID_PREFIX

See Also:

• Constant Field Values

Constructor Details

LightweightUserAdapter

public LightweightUserAdapter(KeycloakSession session,
 String id)

LightweightUserAdapter

public LightweightUserAdapter(KeycloakSession session,
 RealmModel realm,
 String id)

LightweightUserAdapter

protected LightweightUserAdapter()

Method Details

isLightweightUser

public static boolean isLightweightUser(UserModel user)

isLightweightUser

public static boolean isLightweightUser(String id)

getLightweightUserId

public static String getLightweightUserId(String id)

setOwningUserSessionId

public void setOwningUserSessionId(String id)

fromString

public static LightweightUserAdapter fromString(KeycloakSession session,
 RealmModel realm,
 String serializedForm)

credentialManager

public SubjectCredentialManager credentialManager()

Description copied from interface: UserModel

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

serialize

public String serialize()

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

Overrides:

deleteRoleMapping in class AbstractInMemoryUserAdapter

Parameters:

role - Role to remove

grantRole

public void grantRole(RoleModel role)

Description copied from interface: RoleMapperModel

Grants the given role to this object.

Specified by:

grantRole in interface RoleMapperModel

Overrides:

grantRole in class AbstractInMemoryUserAdapter

setServiceAccountClientLink

public void setServiceAccountClientLink(String clientInternalId)

Specified by:

setServiceAccountClientLink in interface UserModel

Overrides:

setServiceAccountClientLink in class AbstractInMemoryUserAdapter

setFederationLink

public void setFederationLink(String link)

Specified by:

setFederationLink in interface UserModel

Overrides:

setFederationLink in class AbstractInMemoryUserAdapter

leaveGroup

public void leaveGroup(GroupModel group)

Specified by:

leaveGroup in interface UserModel

Overrides:

leaveGroup in class AbstractInMemoryUserAdapter

joinGroup

public void joinGroup(GroupModel group)

Specified by:

joinGroup in interface UserModel

Overrides:

joinGroup in class AbstractInMemoryUserAdapter

setEmailVerified

public void setEmailVerified(boolean verified)

Specified by:

setEmailVerified in interface UserModel

Overrides:

setEmailVerified in class AbstractInMemoryUserAdapter

removeRequiredAction

public void removeRequiredAction(UserModel.RequiredAction action)

Specified by:

removeRequiredAction in interface UserModel

Overrides:

removeRequiredAction in class AbstractInMemoryUserAdapter

addRequiredAction

public void addRequiredAction(UserModel.RequiredAction action)

Specified by:

addRequiredAction in interface UserModel

Overrides:

addRequiredAction in class AbstractInMemoryUserAdapter

removeRequiredAction

public void removeRequiredAction(String action)

Specified by:

removeRequiredAction in interface UserModel

Overrides:

removeRequiredAction in class AbstractInMemoryUserAdapter

addRequiredAction

public void addRequiredAction(String action)

Specified by:

addRequiredAction in interface UserModel

Overrides:

addRequiredAction in class AbstractInMemoryUserAdapter

removeAttribute

public void removeAttribute(String name)

Specified by:

removeAttribute in interface UserModel

Overrides:

removeAttribute in class AbstractInMemoryUserAdapter

setAttribute

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

Specified by:

setAttribute in interface UserModel

Overrides:

setAttribute in class AbstractInMemoryUserAdapter

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

Overrides:

setSingleAttribute in class AbstractInMemoryUserAdapter

setEnabled

public void setEnabled(boolean enabled)

Specified by:

setEnabled in interface UserModel

Overrides:

setEnabled in class AbstractInMemoryUserAdapter

setCreatedTimestamp

public void setCreatedTimestamp(Long timestamp)

Specified by:

setCreatedTimestamp in interface UserModel

Overrides:

setCreatedTimestamp in class AbstractInMemoryUserAdapter

setReadonly

public void setReadonly(boolean flag)

Overrides:

setReadonly in class AbstractInMemoryUserAdapter

addDefaults

public void addDefaults()

Overrides:

addDefaults in class AbstractInMemoryUserAdapter

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

Overrides:

setUsername in class AbstractInMemoryUserAdapter

Parameters:

username - username string

setUpdateHandler

public void setUpdateHandler(Consumer<LightweightUserAdapter> updateHandler)

addConsent

public void addConsent(UserConsentModel consent)

getConsentByClient

public UserConsentModel getConsentByClient(String clientInternalId)

revokeConsentForClient

public boolean revokeConsentForClient(String clientInternalId)

updateConsent

public void updateConsent(UserConsentModel consent)

getConsentsStream

public Stream<UserConsentModel> getConsentsStream()