Package org.keycloak.storage.adapter

Class AbstractUserAdapter

java.lang.Object

org.keycloak.models.UserModelDefaultMethods

org.keycloak.storage.adapter.AbstractUserAdapter

All Implemented Interfaces:

RoleMapperModel, UserModel

Direct Known Subclasses:

AbstractUserAdapter.Streams

public abstract class AbstractUserAdapter
extends UserModelDefaultMethods

This abstract class provides implementations for everything but getUsername(). getId() returns a default value of "f:" + providerId + ":" + getUsername(). isEnabled() returns true. getRoleMappings() will return default roles. getGroups() will return default groups. All other read methods return null, an empty collection, or false depending on the type. All update methods throw a ReadOnlyException. Provider implementors should override the methods for attributes, properties, and mappings they support.

Version:

$Revision: 1 $

Author:

Bill Burke

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	AbstractUserAdapter.Streams	The AbstractUserAdapter.Streams interface makes all collection-based methods in AbstractUserAdapter default by providing implementations that delegate to the Stream-based variants instead of the other way around.

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

UserModel.RequiredAction, UserModel.UserPreRemovedEvent, UserModel.UserRemovedEvent

Field Summary

Fields

Modifier and Type	Field	Description
protected long	created
protected RealmModel	realm
protected KeycloakSession	session
protected StorageId	storageId
protected ComponentModel	storageProviderModel

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
AbstractUserAdapter(KeycloakSession session, RealmModel realm, ComponentModel storageProviderModel)

Method Summary

Modifier and Type	Method	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)	Deprecated. Use getAttributeStream(String) instead
Map<String,List<String>>	getAttributes()
Stream<String>	getAttributeStream(String name)
Set<RoleModel>	getClientRoleMappings(ClientModel app)	Deprecated. Use getClientRoleMappingsStream(ClientModel) instead
Stream<RoleModel>	getClientRoleMappingsStream(ClientModel app)
Long	getCreatedTimestamp()
String	getEmail()
String	getFederationLink()	This method should not be overridden
String	getFirstAttribute(String name)
String	getFirstName()
Set<GroupModel>	getGroups()	Deprecated. Use getGroupsStream() instead
protected Set<GroupModel>	getGroupsInternal()	Get group membership mappings that are managed by this storage provider
Stream<GroupModel>	getGroupsStream()
String	getId()	Defaults to 'f:' + storageProvider.getId() + ':' + getUsername()
String	getLastName()
Set<RoleModel>	getRealmRoleMappings()	Deprecated. Use getRealmRoleMappingsStream() instead
Stream<RoleModel>	getRealmRoleMappingsStream()
Set<String>	getRequiredActions()	Deprecated. User getRequiredActionsStream()
Stream<String>	getRequiredActionsStream()
Set<RoleModel>	getRoleMappings()	Deprecated. Use getRoleMappingsStream() instead
protected Set<RoleModel>	getRoleMappingsInternal()
Stream<RoleModel>	getRoleMappingsStream()
String	getServiceAccountClientLink()	This method should not be overridden
void	grantRole(RoleModel role)
int	hashCode()
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	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 overridden
void	setFirstName(String firstName)
void	setLastName(String lastName)
void	setServiceAccountClientLink(String clientInternalId)	This method should not be overridden
void	setSingleAttribute(String name, String value)
void	setUsername(String username)

Methods inherited from class org.keycloak.models.UserModelDefaultMethods

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

credentialManager, getGroupsCount, getGroupsCountByNameContaining, getGroupsStream, getUsername, isFederated, joinGroup

Field Details

session

protected KeycloakSession session

realm

protected RealmModel realm

storageProviderModel

protected ComponentModel storageProviderModel

storageId

protected StorageId storageId

created

protected long created

Constructor Details

AbstractUserAdapter

public AbstractUserAdapter(KeycloakSession session,
 RealmModel realm,
 ComponentModel storageProviderModel)

Method Details

getRequiredActions

public Set<String> getRequiredActions()

Deprecated.

User getRequiredActionsStream()

getRequiredActionsStream

public Stream<String> getRequiredActionsStream()

addRequiredAction

public void addRequiredAction(String action)

removeRequiredAction

public void removeRequiredAction(String action)

addRequiredAction

public void addRequiredAction(UserModel.RequiredAction action)

removeRequiredAction

public void removeRequiredAction(UserModel.RequiredAction action)

getGroupsInternal

protected Set<GroupModel> getGroupsInternal()

Get group membership mappings that are managed by this storage provider

Returns:

appendDefaultGroups

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

Returns:

getGroups

public Set<GroupModel> getGroups()

Deprecated.

Use getGroupsStream() instead

getGroupsStream

public Stream<GroupModel> getGroupsStream()

joinGroup

public void joinGroup(GroupModel group)

leaveGroup

public void leaveGroup(GroupModel group)

isMemberOf

public boolean isMemberOf(GroupModel group)

getRealmRoleMappings

public Set<RoleModel> getRealmRoleMappings()

Deprecated.

Use getRealmRoleMappingsStream() instead

getRealmRoleMappingsStream

public Stream<RoleModel> getRealmRoleMappingsStream()

getClientRoleMappings

public Set<RoleModel> getClientRoleMappings(ClientModel app)

Deprecated.

Use getClientRoleMappingsStream(ClientModel) instead

getClientRoleMappingsStream

public Stream<RoleModel> getClientRoleMappingsStream(ClientModel app)

hasRole

public boolean hasRole(RoleModel role)

grantRole

public void grantRole(RoleModel role)

appendDefaultRolesToRoleMappings

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

Returns:

getRoleMappingsInternal

protected Set<RoleModel> getRoleMappingsInternal()

getRoleMappings

public Set<RoleModel> getRoleMappings()

Deprecated.

Use getRoleMappingsStream() instead

getRoleMappingsStream

public Stream<RoleModel> getRoleMappingsStream()

deleteRoleMapping

public void deleteRoleMapping(RoleModel role)

isEnabled

public boolean isEnabled()

setEnabled

public void setEnabled(boolean enabled)

getFederationLink

public String getFederationLink()

This method should not be overridden

Returns:

setFederationLink

public void setFederationLink(String link)

This method should not be overridden

getServiceAccountClientLink

public String getServiceAccountClientLink()

This method should not be overridden

Returns:

setServiceAccountClientLink

public void setServiceAccountClientLink(String clientInternalId)

This method should not be overridden

getId

public String getId()

Defaults to 'f:' + storageProvider.getId() + ':' + getUsername()

Returns:

setUsername

public void setUsername(String username)

getCreatedTimestamp

public Long getCreatedTimestamp()

setCreatedTimestamp

public void setCreatedTimestamp(Long timestamp)

setSingleAttribute

public void setSingleAttribute(String name,
 String value)

removeAttribute

public void removeAttribute(String name)

setAttribute

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

getFirstAttribute

public String getFirstAttribute(String name)

getAttributes

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

getAttribute

public List<String> getAttribute(String name)

Deprecated.

Use getAttributeStream(String) instead

getAttributeStream

public Stream<String> getAttributeStream(String name)

getFirstName

public String getFirstName()

Specified by:

getFirstName in interface UserModel

Overrides:

getFirstName in class UserModelDefaultMethods

setFirstName

public void setFirstName(String firstName)

Specified by:

setFirstName in interface UserModel

Overrides:

setFirstName in class UserModelDefaultMethods

getLastName

public String getLastName()

Specified by:

getLastName in interface UserModel

Overrides:

getLastName in class UserModelDefaultMethods

setLastName

public void setLastName(String lastName)

Specified by:

setLastName in interface UserModel

Overrides:

setLastName in class UserModelDefaultMethods

getEmail

public String getEmail()

Specified by:

getEmail in interface UserModel

Overrides:

getEmail in class UserModelDefaultMethods

setEmail

public void setEmail(String email)

Specified by:

setEmail in interface UserModel

Overrides:

setEmail in class UserModelDefaultMethods

isEmailVerified

public boolean isEmailVerified()

setEmailVerified

public void setEmailVerified(boolean verified)

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object