org.keycloak.models.jpa.UserAdapter クラス

org.keycloak.models.jpa.UserAdapter の継承関係図

org.keycloak.models.jpa.UserAdapter 連携図

公開メンバ関数
	UserAdapter (KeycloakSession session, RealmModel realm, EntityManager em, UserEntity user)
UserEntity	getEntity ()
String	getId ()
String	getUsername ()
void	setUsername (String username)
Long	getCreatedTimestamp ()
void	setCreatedTimestamp (Long timestamp)
boolean	isEnabled ()
void	setEnabled (boolean enabled)
void	setSingleAttribute (String name, String value)
void	setAttribute (String name, List< String > values)
void	removeAttribute (String name)
String	getFirstAttribute (String name)
List< String >	getAttribute (String name)
Map< String, List< String > >	getAttributes ()
Set< String >	getRequiredActions ()
void	addRequiredAction (RequiredAction action)
void	addRequiredAction (String actionName)
void	removeRequiredAction (RequiredAction action)
void	removeRequiredAction (String actionName)
String	getFirstName ()
void	setFirstName (String firstName)
String	getLastName ()
void	setLastName (String lastName)
String	getEmail ()
void	setEmail (String email)
boolean	isEmailVerified ()
void	setEmailVerified (boolean verified)
Set< GroupModel >	getGroups ()
void	joinGroup (GroupModel group)
void	leaveGroup (GroupModel group)
boolean	isMemberOf (GroupModel group)
boolean	hasRole (RoleModel role)
void	grantRole (RoleModel role)
void	grantRoleImpl (RoleModel role)
Set< RoleModel >	getRealmRoleMappings ()
Set< RoleModel >	getRoleMappings ()
void	deleteRoleMapping (RoleModel role)
Set< RoleModel >	getClientRoleMappings (ClientModel app)
String	getFederationLink ()
void	setFederationLink (String link)
String	getServiceAccountClientLink ()
void	setServiceAccountClientLink (String clientInternalId)
boolean	equals (Object o)
int	hashCode ()

公開変数類
String	USERNAME = "username"
String	LAST_NAME = "lastName"
String	FIRST_NAME = "firstName"
String	EMAIL = "email"
String	LOCALE = "locale"

限定公開メンバ関数
void	joinGroupImpl (GroupModel group)
TypedQuery< UserGroupMembershipEntity >	getUserGroupMappingQuery (GroupModel group)
TypedQuery< UserRoleMappingEntity >	getUserRoleMappingEntityTypedQuery (RoleModel role)

限定公開変数類
UserEntity	user
EntityManager	em
RealmModel	realm

非公開メンバ関数
void	persistAttributeValue (String name, String value)

非公開変数類
final KeycloakSession	session

詳解

著者

Bill Burke

バージョン

Revision

1

構築子と解体子

UserAdapter()

org.keycloak.models.jpa.UserAdapter.UserAdapter ( KeycloakSession  session, RealmModel  realm, EntityManager  em, UserEntity  user  )

inline

                                                                                                     {
        this.em = em;
        this.user = user;
        this.realm = realm;
        this.session = session;
    }

関数詳解

addRequiredAction() [1/2]

void org.keycloak.models.jpa.UserAdapter.addRequiredAction ( RequiredAction  action )

inline

org.keycloak.models.UserModelを実装しています。

                                                         {
        String actionName = action.name();
        addRequiredAction(actionName);
    }

addRequiredAction() [2/2]

void org.keycloak.models.jpa.UserAdapter.addRequiredAction ( String  actionName )

inline

org.keycloak.models.UserModelを実装しています。

                                                     {
        for (UserRequiredActionEntity attr : user.getRequiredActions()) {
            if (attr.getAction().equals(actionName)) {
                return;
            }
        }
        UserRequiredActionEntity attr = new UserRequiredActionEntity();
        attr.setAction(actionName);
        attr.setUser(user);
        em.persist(attr);
        user.getRequiredActions().add(attr);
    }

deleteRoleMapping()

void org.keycloak.models.jpa.UserAdapter.deleteRoleMapping ( RoleModel  role )

inline

org.keycloak.models.RoleMapperModelを実装しています。

                                                  {
        if (user == null || role == null) return;

        TypedQuery<UserRoleMappingEntity> query = getUserRoleMappingEntityTypedQuery(role);
        List<UserRoleMappingEntity> results = query.getResultList();
        if (results.size() == 0) return;
        for (UserRoleMappingEntity entity : results) {
            em.remove(entity);
        }
        em.flush();
    }

equals()

boolean org.keycloak.models.jpa.UserAdapter.equals ( Object  o )

inline

                                    {
        if (this == o) return true;
        if (o == null || !(o instanceof UserModel)) return false;

        UserModel that = (UserModel) o;
        return that.getId().equals(getId());
    }

getAttribute()

List<String> org.keycloak.models.jpa.UserAdapter.getAttribute ( String  name )

inline

org.keycloak.models.UserModelを実装しています。

                                                  {
        List<String> result = new ArrayList<>();
        for (UserAttributeEntity attr : user.getAttributes()) {
            if (attr.getName().equals(name)) {
                result.add(attr.getValue());
            }
        }
        return result;
    }

getAttributes()

Map<String, List<String> > org.keycloak.models.jpa.UserAdapter.getAttributes ( )

inline

org.keycloak.models.UserModelを実装しています。

                                                     {
        MultivaluedHashMap<String, String> result = new MultivaluedHashMap<>();
        for (UserAttributeEntity attr : user.getAttributes()) {
            result.add(attr.getName(), attr.getValue());
        }
        return result;
    }

getClientRoleMappings()

Set<RoleModel> org.keycloak.models.jpa.UserAdapter.getClientRoleMappings ( ClientModel  app )

inline

org.keycloak.models.RoleMapperModelを実装しています。

                                                                 {
        Set<RoleModel> roleMappings = getRoleMappings();

        Set<RoleModel> roles = new HashSet<RoleModel>();
        for (RoleModel role : roleMappings) {
            RoleContainerModel container = role.getContainer();
            if (container instanceof ClientModel) {
                ClientModel appModel = (ClientModel)container;
                if (appModel.getId().equals(app.getId())) {
                   roles.add(role);
                }
            }
        }
        return roles;
    }

getCreatedTimestamp()

Long org.keycloak.models.jpa.UserAdapter.getCreatedTimestamp ( )

inline

org.keycloak.models.UserModelを実装しています。

                                      {
        return user.getCreatedTimestamp();
    }

getEmail()

String org.keycloak.models.jpa.UserAdapter.getEmail ( )

inline

org.keycloak.models.UserModelを実装しています。

                             {
        return user.getEmail();
    }

getEntity()

UserEntity org.keycloak.models.jpa.UserAdapter.getEntity ( )

inline

                                  {
        return user;
    }

getFederationLink()

String org.keycloak.models.jpa.UserAdapter.getFederationLink ( )

inline

org.keycloak.models.UserModelを実装しています。

                                      {
        return user.getFederationLink();
    }

getFirstAttribute()

String org.keycloak.models.jpa.UserAdapter.getFirstAttribute ( String  name )

inline

org.keycloak.models.UserModelを実装しています。

                                                 {
        for (UserAttributeEntity attr : user.getAttributes()) {
            if (attr.getName().equals(name)) {
                return attr.getValue();
            }
        }
        return null;
    }

getFirstName()

String org.keycloak.models.jpa.UserAdapter.getFirstName ( )

inline

org.keycloak.models.UserModelを実装しています。

                                 {
        return user.getFirstName();
    }

getGroups()

Set<GroupModel> org.keycloak.models.jpa.UserAdapter.getGroups ( )

inline

org.keycloak.models.UserModelを実装しています。

                                       {
        // we query ids only as the group  might be cached and following the @ManyToOne will result in a load
        // even if we're getting just the id.
        TypedQuery<String> query = em.createNamedQuery("userGroupIds", String.class);
        query.setParameter("user", getEntity());
        List<String> ids = query.getResultList();
        Set<GroupModel> groups = new HashSet<>();
        for (String groupId : ids) {
            GroupModel group = realm.getGroupById(groupId);
            if (group == null) continue;
            groups.add(group);
        }
        return groups;
    }

getId()

String org.keycloak.models.jpa.UserAdapter.getId ( )

inline

org.keycloak.models.UserModelを実装しています。

                          {
        return user.getId();
    }

getLastName()

String org.keycloak.models.jpa.UserAdapter.getLastName ( )

inline

org.keycloak.models.UserModelを実装しています。

                                {
        return user.getLastName();
    }

getRealmRoleMappings()

Set<RoleModel> org.keycloak.models.jpa.UserAdapter.getRealmRoleMappings ( )

inline

org.keycloak.models.RoleMapperModelを実装しています。

                                                 {
        Set<RoleModel> roleMappings = getRoleMappings();

        Set<RoleModel> realmRoles = new HashSet<RoleModel>();
        for (RoleModel role : roleMappings) {
            RoleContainerModel container = role.getContainer();
            if (container instanceof RealmModel) {
                realmRoles.add(role);
            }
        }
        return realmRoles;
    }

getRequiredActions()

Set<String> org.keycloak.models.jpa.UserAdapter.getRequiredActions ( )

inline

org.keycloak.models.UserModelを実装しています。

                                            {
        Set<String> result = new HashSet<>();
        for (UserRequiredActionEntity attr : user.getRequiredActions()) {
            result.add(attr.getAction());
        }
        return result;
    }

getRoleMappings()

Set<RoleModel> org.keycloak.models.jpa.UserAdapter.getRoleMappings ( )

inline

org.keycloak.models.RoleMapperModelを実装しています。

                                            {
        // we query ids only as the role might be cached and following the @ManyToOne will result in a load
        // even if we're getting just the id.
        TypedQuery<String> query = em.createNamedQuery("userRoleMappingIds", String.class);
        query.setParameter("user", getEntity());
        List<String> ids = query.getResultList();
        Set<RoleModel> roles = new HashSet<RoleModel>();
        for (String roleId : ids) {
            RoleModel roleById = realm.getRoleById(roleId);
            if (roleById == null) continue;
            roles.add(roleById);
        }
        return roles;
    }

getServiceAccountClientLink()

String org.keycloak.models.jpa.UserAdapter.getServiceAccountClientLink ( )

inline

org.keycloak.models.UserModelを実装しています。

                                                {
        return user.getServiceAccountClientLink();
    }

getUserGroupMappingQuery()

TypedQuery<UserGroupMembershipEntity> org.keycloak.models.jpa.UserAdapter.getUserGroupMappingQuery ( GroupModel  group )

inlineprotected

                                                                                               {
        TypedQuery<UserGroupMembershipEntity> query = em.createNamedQuery("userMemberOf", UserGroupMembershipEntity.class);
        query.setParameter("user", getEntity());
        query.setParameter("groupId", group.getId());
        return query;
    }

getUsername()

String org.keycloak.models.jpa.UserAdapter.getUsername ( )

inline

org.keycloak.models.UserModelを実装しています。

                                {
        return user.getUsername();
    }

getUserRoleMappingEntityTypedQuery()

TypedQuery<UserRoleMappingEntity> org.keycloak.models.jpa.UserAdapter.getUserRoleMappingEntityTypedQuery ( RoleModel  role )

inlineprotected

                                                                                                   {
        TypedQuery<UserRoleMappingEntity> query = em.createNamedQuery("userHasRole", UserRoleMappingEntity.class);
        query.setParameter("user", getEntity());
        query.setParameter("roleId", role.getId());
        return query;
    }

grantRole()

void org.keycloak.models.jpa.UserAdapter.grantRole ( RoleModel  role )

inline

org.keycloak.models.RoleMapperModelを実装しています。

                                          {
        if (hasRole(role)) return;
        grantRoleImpl(role);
    }

grantRoleImpl()

void org.keycloak.models.jpa.UserAdapter.grantRoleImpl ( RoleModel  role )

inline

                                              {
        UserRoleMappingEntity entity = new UserRoleMappingEntity();
        entity.setUser(getEntity());
        entity.setRoleId(role.getId());
        em.persist(entity);
        em.flush();
        em.detach(entity);
    }

hashCode()

int org.keycloak.models.jpa.UserAdapter.hashCode ( )

inline

                          {
        return getId().hashCode();
    }

hasRole()

boolean org.keycloak.models.jpa.UserAdapter.hasRole ( RoleModel  role )

inline

org.keycloak.models.RoleMapperModelを実装しています。

                                           {
        Set<RoleModel> roles = getRoleMappings();
        return RoleUtils.hasRole(roles, role)
          || RoleUtils.hasRoleFromGroup(getGroups(), role, true);
    }

isEmailVerified()

boolean org.keycloak.models.jpa.UserAdapter.isEmailVerified ( )

inline

org.keycloak.models.UserModelを実装しています。

                                     {
        return user.isEmailVerified();
    }

isEnabled()

boolean org.keycloak.models.jpa.UserAdapter.isEnabled ( )

inline

org.keycloak.models.UserModelを実装しています。

                               {
        return user.isEnabled();
    }

isMemberOf()

boolean org.keycloak.models.jpa.UserAdapter.isMemberOf ( GroupModel  group )

inline

org.keycloak.models.UserModelを実装しています。

                                                {
        Set<GroupModel> roles = getGroups();
        return RoleUtils.isMember(roles, group);
    }

joinGroup()

void org.keycloak.models.jpa.UserAdapter.joinGroup ( GroupModel  group )

inline

org.keycloak.models.UserModelを実装しています。

                                            {
        if (isMemberOf(group)) return;
        joinGroupImpl(group);

    }

joinGroupImpl()

void org.keycloak.models.jpa.UserAdapter.joinGroupImpl ( GroupModel  group )

inlineprotected

                                                   {
        UserGroupMembershipEntity entity = new UserGroupMembershipEntity();
        entity.setUser(getEntity());
        entity.setGroupId(group.getId());
        em.persist(entity);
        em.flush();
        em.detach(entity);

    }

leaveGroup()

void org.keycloak.models.jpa.UserAdapter.leaveGroup ( GroupModel  group )

inline

org.keycloak.models.UserModelを実装しています。

                                             {
        if (user == null || group == null) return;

        TypedQuery<UserGroupMembershipEntity> query = getUserGroupMappingQuery(group);
        List<UserGroupMembershipEntity> results = query.getResultList();
        if (results.size() == 0) return;
        for (UserGroupMembershipEntity entity : results) {
            em.remove(entity);
        }
        em.flush();

    }

persistAttributeValue()

void org.keycloak.models.jpa.UserAdapter.persistAttributeValue ( String  name, String  value  )

inlineprivate

                                                                  {
        UserAttributeEntity attr = new UserAttributeEntity();
        attr.setId(KeycloakModelUtils.generateId());
        attr.setName(name);
        attr.setValue(value);
        attr.setUser(user);
        em.persist(attr);
        user.getAttributes().add(attr);
    }

removeAttribute()

void org.keycloak.models.jpa.UserAdapter.removeAttribute ( String  name )

inline

org.keycloak.models.UserModelを実装しています。

                                             {
        // KEYCLOAK-3296 : Remove attribute through HQL to avoid StaleUpdateException
        Query query = em.createNamedQuery("deleteUserAttributesByNameAndUser");
        query.setParameter("name", name);
        query.setParameter("userId", user.getId());
        int numUpdated = query.executeUpdate();

        // KEYCLOAK-3494 : Also remove attributes from local user entity
        List<UserAttributeEntity> toRemove = new ArrayList<>();
        for (UserAttributeEntity attr : user.getAttributes()) {
            if (attr.getName().equals(name)) {
                toRemove.add(attr);
            }
        }
        user.getAttributes().removeAll(toRemove);
    }

removeRequiredAction() [1/2]

void org.keycloak.models.jpa.UserAdapter.removeRequiredAction ( RequiredAction  action )

inline

org.keycloak.models.UserModelを実装しています。

                                                            {
        String actionName = action.name();
        removeRequiredAction(actionName);
    }

removeRequiredAction() [2/2]

void org.keycloak.models.jpa.UserAdapter.removeRequiredAction ( String  actionName )

inline

org.keycloak.models.UserModelを実装しています。

                                                        {
        Iterator<UserRequiredActionEntity> it = user.getRequiredActions().iterator();
        while (it.hasNext()) {
            UserRequiredActionEntity attr = it.next();
            if (attr.getAction().equals(actionName)) {
                it.remove();
                em.remove(attr);
            }
        }
    }

setAttribute()

void org.keycloak.models.jpa.UserAdapter.setAttribute ( String  name, List< String >  values  )

inline

org.keycloak.models.UserModelを実装しています。

                                                               {
        // Remove all existing
        removeAttribute(name);

        // Put all new
        for (String value : values) {
            persistAttributeValue(name, value);
        }
    }

setCreatedTimestamp()

void org.keycloak.models.jpa.UserAdapter.setCreatedTimestamp ( Long  timestamp )

inline

org.keycloak.models.UserModelを実装しています。

                                                    {
        user.setCreatedTimestamp(timestamp);
    }

setEmail()

void org.keycloak.models.jpa.UserAdapter.setEmail ( String  email )

inline

org.keycloak.models.UserModelを実装しています。

                                       {
        email = KeycloakModelUtils.toLowerCaseSafe(email);
        user.setEmail(email, realm.isDuplicateEmailsAllowed());
    }

setEmailVerified()

void org.keycloak.models.jpa.UserAdapter.setEmailVerified ( boolean  verified )

inline

org.keycloak.models.UserModelを実装しています。

                                                   {
        user.setEmailVerified(verified);
    }

setEnabled()

void org.keycloak.models.jpa.UserAdapter.setEnabled ( boolean  enabled )

inline

org.keycloak.models.UserModelを実装しています。

                                            {
        user.setEnabled(enabled);
    }

setFederationLink()

void org.keycloak.models.jpa.UserAdapter.setFederationLink ( String  link )

inline

org.keycloak.models.UserModelを実装しています。

                                               {
        user.setFederationLink(link);
    }

setFirstName()

void org.keycloak.models.jpa.UserAdapter.setFirstName ( String  firstName )

inline

org.keycloak.models.UserModelを実装しています。

                                               {
        user.setFirstName(firstName);
    }

setLastName()

void org.keycloak.models.jpa.UserAdapter.setLastName ( String  lastName )

inline

org.keycloak.models.UserModelを実装しています。

                                             {
        user.setLastName(lastName);
    }

setServiceAccountClientLink()

void org.keycloak.models.jpa.UserAdapter.setServiceAccountClientLink ( String  clientInternalId )

inline

org.keycloak.models.UserModelを実装しています。

                                                                     {
        user.setServiceAccountClientLink(clientInternalId);
    }

setSingleAttribute()

void org.keycloak.models.jpa.UserAdapter.setSingleAttribute ( String  name, String  value  )

inline

org.keycloak.models.UserModelを実装しています。

                                                              {
        String firstExistingAttrId = null;
        List<UserAttributeEntity> toRemove = new ArrayList<>();
        for (UserAttributeEntity attr : user.getAttributes()) {
            if (attr.getName().equals(name)) {
                if (firstExistingAttrId == null) {
                    attr.setValue(value);
                    firstExistingAttrId = attr.getId();
                } else {
                    toRemove.add(attr);
                }
            }
        }

        if (firstExistingAttrId != null) {
            // Remove attributes through HQL to avoid StaleUpdateException
            Query query = em.createNamedQuery("deleteUserAttributesByNameAndUserOtherThan");
            query.setParameter("name", name);
            query.setParameter("userId", user.getId());
            query.setParameter("attrId", firstExistingAttrId);
            int numUpdated = query.executeUpdate();

            // Remove attribute from local entity
            user.getAttributes().removeAll(toRemove);
        } else {

            persistAttributeValue(name, value);
        }
    }

setUsername()

void org.keycloak.models.jpa.UserAdapter.setUsername ( String  username )

inline

org.keycloak.models.UserModelを実装しています。

                                             {
        username = KeycloakModelUtils.toLowerCaseSafe(username);
        user.setUsername(username);
    }

メンバ詳解

em

EntityManager org.keycloak.models.jpa.UserAdapter.em

protected

EMAIL

String org.keycloak.models.UserModel.EMAIL = "email"

inherited

FIRST_NAME

String org.keycloak.models.UserModel.FIRST_NAME = "firstName"

inherited

LAST_NAME

String org.keycloak.models.UserModel.LAST_NAME = "lastName"

inherited

LOCALE

String org.keycloak.models.UserModel.LOCALE = "locale"

inherited

realm

RealmModel org.keycloak.models.jpa.UserAdapter.realm

protected

session

final KeycloakSession org.keycloak.models.jpa.UserAdapter.session

private

user

UserEntity org.keycloak.models.jpa.UserAdapter.user

protected

USERNAME

String org.keycloak.models.UserModel.USERNAME = "username"

inherited

---

このクラス詳解は次のファイルから抽出されました:

• D:/AppData/doxygen/keycloak/src/keycloak/src/main/java/org/keycloak/models/jpa/UserAdapter.java