org.keycloak.models.map.user

## Class MapUserAdapter

- java.lang.Object
- - org.keycloak.models.map.user.AbstractUserModel<MapUserEntity>
  - - org.keycloak.models.map.user.MapUserAdapter

- All Implemented Interfaces:
    RoleMapperModel, RoleMapperModel.Streams, UserModel, UserModel.Streams

      public abstract class MapUserAdapter
      extends AbstractUserModel<MapUserEntity>

- - ### Nested Class Summary

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

      `UserModel.RequiredAction, UserModel.Streams, UserModel.UserRemovedEvent`

  - ### Field Summary

    - ### Fields inherited from class org.keycloak.models.map.user.AbstractUserModel

      `entity, realm, session`

    - ### Fields inherited from interface org.keycloak.models.UserModel

      `COMPARE_BY_USERNAME, 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 and Description
    `MapUserAdapter(KeycloakSession session, RealmModel realm, MapUserEntity entity)`

  - ### Method Summary

    All Methods Instance Methods Abstract Methods Concrete Methods
    Modifier and Type | Method and Description
    --- | ---
    `void` | `addRequiredAction(String action)`
    `abstract boolean` | `checkEmailUniqueness(RealmModel realm, String email)`
    `abstract boolean` | `checkUsernameUniqueness(RealmModel realm, String username)`
    `void` | `deleteRoleMapping(RoleModel role)` Removes the given role mapping from this object.
    `Map<String,List<String>>` | `getAttributes()`
    `Stream<String>` | `getAttributeStream(String name)` Obtains all values associated with the specified attribute name.
    `Stream<RoleModel>` | `getClientRoleMappingsStream(ClientModel app)` Returns stream of client roles that are directly set to this object for the given client.
    `Long` | `getCreatedTimestamp()` Get timestamp of user creation.
    `String` | `getEmail()`
    `String` | `getFederationLink()`
    `String` | `getFirstAttribute(String name)`
    `String` | `getFirstName()`
    `Stream<GroupModel>` | `getGroupsStream()` Obtains the groups associated with the user.
    `String` | `getId()`
    `String` | `getLastName()`
    `Stream<RoleModel>` | `getRealmRoleMappingsStream()` Returns stream of realm roles that are directly set to this object.
    `Stream<String>` | `getRequiredActionsStream()` Obtains the names of required actions associated with the user.
    `Stream<RoleModel>` | `getRoleMappingsStream()` Returns stream of all role (both realm all client) that are directly set to this object.
    `String` | `getServiceAccountClientLink()`
    `String` | `getUsername()`
    `void` | `grantRole(RoleModel role)` Grants the given role to this object.
    `boolean` | `hasRole(RoleModel role)` Returns `true` if this object is directly or indirectly assigned the given role, `false` otherwise.
    `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` | `setAttribute(String name, List<String> values)`
    `void` | `setCreatedTimestamp(Long timestamp)`
    `void` | `setEmail(String email)` Sets email for this user.
    `void` | `setEmailVerified(boolean verified)`
    `void` | `setEnabled(boolean enabled)`
    `void` | `setFederationLink(String link)`
    `void` | `setFirstName(String firstName)`
    `void` | `setLastName(String lastName)`
    `void` | `setServiceAccountClientLink(String clientInternalId)`
    `void` | `setSingleAttribute(String name, String value)` Set single value of specified attribute.
    `void` | `setUsername(String username)` Sets username for this user.

    - ### Methods inherited from class org.keycloak.models.map.user.AbstractUserModel

      `equals, hashCode`

    - ### Methods inherited from class java.lang.Object

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

    - ### Methods inherited from interface org.keycloak.models.UserModel.Streams

      `getAttribute, getGroups, getRequiredActions`

    - ### Methods inherited from interface org.keycloak.models.UserModel

      `addRequiredAction, getGroups, getGroups, getGroupsCount, getGroupsCountByNameContaining, getGroupsStream, removeRequiredAction`

    - ### Methods inherited from interface org.keycloak.models.RoleMapperModel.Streams

      `getClientRoleMappings, getRealmRoleMappings, getRoleMappings`

- - ### Constructor Detail

    - #### MapUserAdapter

          public MapUserAdapter(KeycloakSession session,
                                RealmModel realm,
                                MapUserEntity entity)

  - ### Method Detail

    - #### getId

          public String getId()

    - #### getUsername

          public String getUsername()

    - #### 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)

    - #### isEnabled

          public boolean isEnabled()

    - #### setEnabled

          public void setEnabled(boolean enabled)

    - #### 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

    - #### setAttribute

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

    - #### removeAttribute

          public void removeAttribute(String name)

    - #### 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.

    - #### getAttributes

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

    - #### 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)

    - #### getFirstName

          public String getFirstName()

    - #### setFirstName

          public void setFirstName(String firstName)

    - #### getLastName

          public String getLastName()

    - #### setLastName

          public void setLastName(String lastName)

    - #### getEmail

          public String getEmail()

    - #### setEmail

          public void setEmail(String email)

      Description copied from interface: `UserModel`
      Sets email for this user.
      Parameters:
        `email` - the email

    - #### checkEmailUniqueness

          public abstract boolean checkEmailUniqueness(RealmModel realm,
                                                       String email)

    - #### checkUsernameUniqueness

          public abstract boolean checkUsernameUniqueness(RealmModel realm,
                                                          String username)

    - #### isEmailVerified

          public boolean isEmailVerified()

    - #### setEmailVerified

          public void setEmailVerified(boolean verified)

    - #### 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)

    - #### getFederationLink

          public String getFederationLink()

    - #### setFederationLink

          public void setFederationLink(String link)

    - #### getServiceAccountClientLink

          public String getServiceAccountClientLink()

    - #### setServiceAccountClientLink

          public void setServiceAccountClientLink(String clientInternalId)

    - #### 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`

    - #### 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` - Client to get the roles for
      Returns:
        stream of `RoleModel`

    - #### 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 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

    - #### grantRole

          public void grantRole(RoleModel role)

      Description copied from interface: `RoleMapperModel`
      Grants the given role to this object.

    - #### 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`

    - #### deleteRoleMapping

          public void deleteRoleMapping(RoleModel role)

      Description copied from interface: `RoleMapperModel`
      Removes the given role mapping from this object.
      Parameters:
        `role` - Role to remove

Copyright © 2021 JBoss by Red Hat. All rights reserved.