org.keycloak.models.mongo.keycloak.adapters

Class UserAdapter

java.lang.Object

org.keycloak.models.mongo.keycloak.adapters.AbstractMongoAdapter<MongoUserEntity>

org.keycloak.models.mongo.keycloak.adapters.UserAdapter

All Implemented Interfaces:

RoleMapperModel, UserModel

public class UserAdapter
extends AbstractMongoAdapter<MongoUserEntity>
implements UserModel

Wrapper around UserData object, which will persist wrapped object after each set operation (compatibility with picketlink based idm)

Author:

Marek Posolda

Nested Class Summary

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

UserModel.RequiredAction, UserModel.UserRemovedEvent

Field Summary

Fields inherited from class org.keycloak.models.mongo.keycloak.adapters.AbstractMongoAdapter

invocationContext

Fields inherited from interface org.keycloak.models.UserModel

EMAIL, FIRST_NAME, LAST_NAME, LOCALE, USERNAME

Constructor Summary

Constructors

Constructor and Description
UserAdapter(KeycloakSession session, RealmModel realm, MongoUserEntity userEntity, MongoStoreInvocationContext invContext)

Method Summary

Modifier and Type	Method and Description
void	addRequiredAction(String actionName)
void	addRequiredAction(UserModel.RequiredAction action)
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()
List<UserCredentialValueModel>	getCredentialsDirectly()
String	getEmail()
String	getFederationLink()
String	getFirstAttribute(String name)
String	getFirstName()
Set<GroupModel>	getGroups()
String	getId()
String	getLastName()
MongoUserEntity	getMongoEntity()
Set<RoleModel>	getRealmRoleMappings()
Set<String>	getRequiredActions()
Set<RoleModel>	getRoleMappings()
String	getServiceAccountClientLink()
MongoUserEntity	getUser()
String	getUsername()
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 actionName)
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)
void	setFirstName(String firstName)
void	setLastName(String lastName)
void	setOtpEnabled(boolean totp)
void	setServiceAccountClientLink(String clientInternalId)
void	setSingleAttribute(String name, String value)
void	setUsername(String username)
void	updateCredential(UserCredentialModel cred)
void	updateCredentialDirectly(UserCredentialValueModel credModel)
protected void	updateUser()

Methods inherited from class org.keycloak.models.mongo.keycloak.adapters.AbstractMongoAdapter

getMongoStore, updateMongoEntity

Methods inherited from class java.lang.Object

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

Constructor Detail

UserAdapter

public UserAdapter(KeycloakSession session,
                   RealmModel realm,
                   MongoUserEntity userEntity,
                   MongoStoreInvocationContext invContext)

Method Detail

getId

public String getId()

Specified by:

getId in interface UserModel

getUsername

public String getUsername()

Specified by:

getUsername in interface UserModel

setUsername

public void setUsername(String username)

Specified by:

setUsername in interface UserModel

getCreatedTimestamp

public Long getCreatedTimestamp()

Specified by:

getCreatedTimestamp in interface UserModel

setCreatedTimestamp

public void setCreatedTimestamp(Long timestamp)

Specified by:

setCreatedTimestamp in interface UserModel

isEnabled

public boolean isEnabled()

Specified by:

isEnabled in interface UserModel

setEnabled

public void setEnabled(boolean enabled)

Specified by:

setEnabled in interface UserModel

getFirstName

public String getFirstName()

Specified by:

getFirstName in interface UserModel

setFirstName

public void setFirstName(String firstName)

Specified by:

setFirstName in interface UserModel

getLastName

public String getLastName()

Specified by:

getLastName in interface UserModel

setLastName

public void setLastName(String lastName)

Specified by:

setLastName in interface UserModel

getEmail

public String getEmail()

Specified by:

getEmail in interface UserModel

setEmail

public void setEmail(String email)

Specified by:

setEmail in interface UserModel

isEmailVerified

public boolean isEmailVerified()

Specified by:

isEmailVerified in interface UserModel

setEmailVerified

public void setEmailVerified(boolean verified)

Specified by:

setEmailVerified in interface UserModel

setSingleAttribute

public void setSingleAttribute(String name,
                               String value)

Specified by:

setSingleAttribute in interface UserModel

setAttribute

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

Specified by:

setAttribute in interface UserModel

removeAttribute

public void removeAttribute(String name)

Specified by:

removeAttribute in interface UserModel

getFirstAttribute

public String getFirstAttribute(String name)

Specified by:

getFirstAttribute in interface UserModel

getAttribute

public List<String> getAttribute(String name)

Specified by:

getAttribute in interface UserModel

getAttributes

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

Specified by:

getAttributes in interface UserModel

getUser

public MongoUserEntity getUser()

getRequiredActions

public Set<String> getRequiredActions()

Specified by:

getRequiredActions in interface UserModel

addRequiredAction

public void addRequiredAction(UserModel.RequiredAction action)

Specified by:

addRequiredAction in interface UserModel

addRequiredAction

public void addRequiredAction(String actionName)

Specified by:

addRequiredAction in interface UserModel

removeRequiredAction

public void removeRequiredAction(UserModel.RequiredAction action)

Specified by:

removeRequiredAction in interface UserModel

removeRequiredAction

public void removeRequiredAction(String actionName)

Specified by:

removeRequiredAction in interface UserModel

isOtpEnabled

public boolean isOtpEnabled()

Specified by:

isOtpEnabled in interface UserModel

setOtpEnabled

public void setOtpEnabled(boolean totp)

Specified by:

setOtpEnabled in interface UserModel

updateCredential

public void updateCredential(UserCredentialModel cred)

Specified by:

updateCredential in interface UserModel

getCredentialsDirectly

public List<UserCredentialValueModel> getCredentialsDirectly()

Specified by:

getCredentialsDirectly in interface UserModel

updateCredentialDirectly

public void updateCredentialDirectly(UserCredentialValueModel credModel)

Specified by:

updateCredentialDirectly in interface UserModel

updateUser

protected void updateUser()

getMongoEntity

public MongoUserEntity getMongoEntity()

Specified by:

getMongoEntity in class AbstractMongoAdapter<MongoUserEntity>

getGroups

public Set<GroupModel> getGroups()

Specified by:

getGroups in interface UserModel

joinGroup

public void joinGroup(GroupModel group)

Specified by:

joinGroup in interface UserModel

leaveGroup

public void leaveGroup(GroupModel group)

Specified by:

leaveGroup in interface UserModel

isMemberOf

public boolean isMemberOf(GroupModel group)

Specified by:

isMemberOf in interface UserModel

hasRole

public boolean hasRole(RoleModel role)

Specified by:

hasRole in interface RoleMapperModel

grantRole

public void grantRole(RoleModel role)

Specified by:

grantRole in interface RoleMapperModel

getRoleMappings

public Set<RoleModel> getRoleMappings()

Specified by:

getRoleMappings in interface RoleMapperModel

getRealmRoleMappings

public Set<RoleModel> getRealmRoleMappings()

Specified by:

getRealmRoleMappings in interface RoleMapperModel

deleteRoleMapping

public void deleteRoleMapping(RoleModel role)

Specified by:

deleteRoleMapping in interface RoleMapperModel

getClientRoleMappings

public Set<RoleModel> getClientRoleMappings(ClientModel app)

Specified by:

getClientRoleMappings in interface RoleMapperModel

getFederationLink

public String getFederationLink()

Specified by:

getFederationLink in interface UserModel

setFederationLink

public void setFederationLink(String link)

Specified by:

setFederationLink in interface UserModel

getServiceAccountClientLink

public String getServiceAccountClientLink()

Specified by:

getServiceAccountClientLink in interface UserModel

setServiceAccountClientLink

public void setServiceAccountClientLink(String clientInternalId)

Specified by:

setServiceAccountClientLink in interface UserModel

equals

public boolean equals(Object o)

Overrides:

equals in class AbstractMongoAdapter<MongoUserEntity>

hashCode

public int hashCode()

Overrides:

hashCode in class AbstractMongoAdapter<MongoUserEntity>