Package org.keycloak.storage.adapter

Class 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

    • Method Detail

      • getRequiredActionsStream

        public Stream<String> getRequiredActionsStream()
        Description copied from interface: UserModel
        Obtains the names of required actions associated with the user.
        Returns:
        a non-null Stream of required action names.

      • addRequiredAction

        public void addRequiredAction​(String action)

      • removeRequiredAction

        public void removeRequiredAction​(String 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:

      • getGroupsStream

        public Stream<GroupModel> getGroupsStream()
        Description copied from interface: UserModel
        Obtains the groups associated with the user.
        Returns:
        a non-null Stream of groups.

      • joinGroup

        public void joinGroup​(GroupModel group)

      • leaveGroup

        public void leaveGroup​(GroupModel group)

      • isMemberOf

        public boolean isMemberOf​(GroupModel group)

      • getRealmRoleMappingsStream

        public Stream<RoleModel> getRealmRoleMappingsStream()
        Description copied from interface: RoleMapperModel
        Returns stream of realm roles that are directly set to this object.
        Returns:
        Stream of RoleModel. Never returns null.

      • getClientRoleMappingsStream

        public Stream<RoleModel> getClientRoleMappingsStream​(ClientModel app)
        Description copied from interface: RoleMapperModel
        Returns stream of client roles that are directly set to this object for the given client.
        Parameters:
        app - ClientModel Client to get the roles for.
        Returns:
        Stream of RoleModel. Never returns null.

      • hasRole

        public boolean hasRole​(RoleModel role)
        Description copied from interface: RoleMapperModel
        Returns true if this object is directly or indirectly assigned the given role, false otherwise.

        For example, true is returned for hasRole(R) if:

        • R is directly assigned to this object
        • R is indirectly assigned to this object via composites
        • R is not assigned to this object but this object belongs to a group G which is assigned the role R
        • R is not assigned to this object but this object belongs to a group G, and G belongs to group H which is assigned the role R
        Returns:
        see description
        See Also:
        if you want to check if this object is directly assigned to a role

      • grantRole

        public void grantRole​(RoleModel role)
        Description copied from interface: RoleMapperModel
        Grants the given role to this object.

      • 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()

      • getRoleMappingsStream

        public Stream<RoleModel> getRoleMappingsStream()
        Description copied from interface: RoleMapperModel
        Returns stream of all role (both realm all client) that are directly set to this object.
        Returns:
        Stream of RoleModel. Never returns null.

      • deleteRoleMapping

        public void deleteRoleMapping​(RoleModel role)
        Description copied from interface: RoleMapperModel
        Removes the given role mapping from this object.
        Parameters:
        role - Role to remove

      • isEnabled

        public boolean isEnabled()

      • setEnabled

        public void setEnabled​(boolean enabled)

      • getFederationLink

        public String getFederationLink()
        This method should not be overriden
        Returns:

      • setFederationLink

        public void setFederationLink​(String link)
        This method should not be overriden

      • getServiceAccountClientLink

        public String getServiceAccountClientLink()
        This method should not be overriden
        Returns:

      • setServiceAccountClientLink

        public void setServiceAccountClientLink​(String clientInternalId)
        This method should not be overriden

      • getId

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

      • 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
        Parameters:
        username - username string

      • getCreatedTimestamp

        public Long getCreatedTimestamp()
        Description copied from interface: UserModel
        Get timestamp of user creation. May be null for old users created before this feature introduction.

      • setCreatedTimestamp

        public void setCreatedTimestamp​(Long timestamp)

      • 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

      • removeAttribute

        public void removeAttribute​(String name)

      • setAttribute

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

      • getFirstAttribute

        public String getFirstAttribute​(String name)
        Returns:
        null if there is not any value of specified attribute or first value otherwise. Don't throw exception if there are more values of the attribute

      • getAttributeStream

        public Stream<String> getAttributeStream​(String name)
        Description copied from interface: UserModel
        Obtains all values associated with the specified attribute name.
        Parameters:
        name - the name of the attribute.
        Returns:
        a non-null Stream of attribute values.

      • isEmailVerified

        public boolean isEmailVerified()

      • setEmailVerified

        public void setEmailVerified​(boolean verified)

      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class Object