Package org.keycloak.storage.adapter

Class AbstractUserAdapter

java.lang.Object
org.keycloak.models.UserModelDefaultMethods
org.keycloak.storage.adapter.AbstractUserAdapter
All Implemented Interfaces:
org.keycloak.models.Model, org.keycloak.models.RoleMapperModel, org.keycloak.models.UserModel
Direct Known Subclasses:
AbstractUserAdapter.Streams
public abstract class AbstractUserAdapter extends org.keycloak.models.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

  • Field Details

    • session

      protected org.keycloak.models.KeycloakSession session

    • realm

      protected org.keycloak.models.RealmModel realm

    • storageProviderModel

      protected org.keycloak.component.ComponentModel storageProviderModel

    • storageId

      protected org.keycloak.storage.StorageId storageId

    • created

      protected long created

  • Constructor Details

    • AbstractUserAdapter

      public AbstractUserAdapter(org.keycloak.models.KeycloakSession session, org.keycloak.models.RealmModel realm, org.keycloak.component.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(org.keycloak.models.UserModel.RequiredAction action)

    • removeRequiredAction

      public void removeRequiredAction(org.keycloak.models.UserModel.RequiredAction action)

    • getGroupsInternal

      protected Set<org.keycloak.models.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<org.keycloak.models.GroupModel> getGroups()
      Deprecated.
      Use getGroupsStream() instead

    • getGroupsStream

      public Stream<org.keycloak.models.GroupModel> getGroupsStream()

    • joinGroup

      public void joinGroup(org.keycloak.models.GroupModel group)

    • leaveGroup

      public void leaveGroup(org.keycloak.models.GroupModel group)

    • isMemberOf

      public boolean isMemberOf(org.keycloak.models.GroupModel group)

    • getRealmRoleMappings

      public Set<org.keycloak.models.RoleModel> getRealmRoleMappings()
      Deprecated.
      Use getRealmRoleMappingsStream() instead

    • getRealmRoleMappingsStream

      public Stream<org.keycloak.models.RoleModel> getRealmRoleMappingsStream()

    • getClientRoleMappings

      public Set<org.keycloak.models.RoleModel> getClientRoleMappings(org.keycloak.models.ClientModel app)
      Deprecated.
      Use getClientRoleMappingsStream(ClientModel) instead

    • getClientRoleMappingsStream

      public Stream<org.keycloak.models.RoleModel> getClientRoleMappingsStream(org.keycloak.models.ClientModel app)

    • hasRole

      public boolean hasRole(org.keycloak.models.RoleModel role)

    • grantRole

      public void grantRole(org.keycloak.models.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<org.keycloak.models.RoleModel> getRoleMappingsInternal()

    • getRoleMappings

      public Set<org.keycloak.models.RoleModel> getRoleMappings()
      Deprecated.
      Use getRoleMappingsStream() instead

    • getRoleMappingsStream

      public Stream<org.keycloak.models.RoleModel> getRoleMappingsStream()

    • deleteRoleMapping

      public void deleteRoleMapping(org.keycloak.models.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 org.keycloak.models.UserModel
      Overrides:
      getFirstName in class org.keycloak.models.UserModelDefaultMethods

    • setFirstName

      public void setFirstName(String firstName)
      Specified by:
      setFirstName in interface org.keycloak.models.UserModel
      Overrides:
      setFirstName in class org.keycloak.models.UserModelDefaultMethods

    • getLastName

      public String getLastName()
      Specified by:
      getLastName in interface org.keycloak.models.UserModel
      Overrides:
      getLastName in class org.keycloak.models.UserModelDefaultMethods

    • setLastName

      public void setLastName(String lastName)
      Specified by:
      setLastName in interface org.keycloak.models.UserModel
      Overrides:
      setLastName in class org.keycloak.models.UserModelDefaultMethods

    • getEmail

      public String getEmail()
      Specified by:
      getEmail in interface org.keycloak.models.UserModel
      Overrides:
      getEmail in class org.keycloak.models.UserModelDefaultMethods

    • setEmail

      public void setEmail(String email)
      Specified by:
      setEmail in interface org.keycloak.models.UserModel
      Overrides:
      setEmail in class org.keycloak.models.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