org.keycloak.storage.adapter.AbstractUserAdapter クラス

org.keycloak.storage.adapter.AbstractUserAdapter の継承関係図

org.keycloak.storage.adapter.AbstractUserAdapter 連携図

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

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

限定公開メンバ関数
Set< GroupModel >	getGroupsInternal ()
boolean	appendDefaultGroups ()
boolean	appendDefaultRolesToRoleMappings ()
Set< RoleModel >	getRoleMappingsInternal ()

限定公開変数類
KeycloakSession	session
RealmModel	realm
ComponentModel	storageProviderModel
StorageId	storageId
long	created = System.currentTimeMillis()

詳解

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.

著者

Bill Burke

バージョン

Revision

1

構築子と解体子

AbstractUserAdapter()

org.keycloak.storage.adapter.AbstractUserAdapter.AbstractUserAdapter ( KeycloakSession  session, RealmModel  realm, ComponentModel  storageProviderModel  )

inline

                                                                                                               {
        this.session = session;
        this.realm = realm;
        this.storageProviderModel = storageProviderModel;
    }

関数詳解

addRequiredAction() [1/2]

void org.keycloak.storage.adapter.AbstractUserAdapter.addRequiredAction ( String  action )

inline

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

                                                 {
        throw new ReadOnlyException("user is read only for this update");

    }

addRequiredAction() [2/2]

void org.keycloak.storage.adapter.AbstractUserAdapter.addRequiredAction ( RequiredAction  action )

inline

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

                                                         {
        throw new ReadOnlyException("user is read only for this update");

    }

appendDefaultGroups()

boolean org.keycloak.storage.adapter.AbstractUserAdapter.appendDefaultGroups ( )

inlineprotected

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

戻り値

                                            {
        return true;
    }

appendDefaultRolesToRoleMappings()

boolean org.keycloak.storage.adapter.AbstractUserAdapter.appendDefaultRolesToRoleMappings ( )

inlineprotected

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

戻り値

                                                         {
        return true;
    }

deleteRoleMapping()

void org.keycloak.storage.adapter.AbstractUserAdapter.deleteRoleMapping ( RoleModel  role )

inline

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

                                                  {
        throw new ReadOnlyException("user is read only for this update");

    }

equals()

boolean org.keycloak.storage.adapter.AbstractUserAdapter.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.storage.adapter.AbstractUserAdapter.getAttribute ( String  name )

inline

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

                                                  {
        return null;
    }

getAttributes()

Map<String, List<String> > org.keycloak.storage.adapter.AbstractUserAdapter.getAttributes ( )

inline

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

                                                     {
        return new MultivaluedHashMap<>();
    }

getClientRoleMappings()

Set<RoleModel> org.keycloak.storage.adapter.AbstractUserAdapter.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.storage.adapter.AbstractUserAdapter.getCreatedTimestamp ( )

inline

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

                                      {
        return created;
    }

getEmail()

String org.keycloak.storage.adapter.AbstractUserAdapter.getEmail ( )

inline

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

                             {
        return null;
    }

getFederationLink()

String org.keycloak.storage.adapter.AbstractUserAdapter.getFederationLink ( )

inline

This method should not be overriden

戻り値

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

                                      {
        return null;
    }

getFirstAttribute()

String org.keycloak.storage.adapter.AbstractUserAdapter.getFirstAttribute ( String  name )

inline

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

                                                 {
        return null;
    }

getFirstName()

String org.keycloak.storage.adapter.AbstractUserAdapter.getFirstName ( )

inline

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

                                 {
        return null;
    }

getGroups()

Set<GroupModel> org.keycloak.storage.adapter.AbstractUserAdapter.getGroups ( )

inline

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

                                       {
        Set<GroupModel> set = new HashSet<>();
        if (appendDefaultGroups()) set.addAll(realm.getDefaultGroups());
        set.addAll(getGroupsInternal());
        return set;
    }

getGroupsInternal()

Set<GroupModel> org.keycloak.storage.adapter.AbstractUserAdapter.getGroupsInternal ( )

inlineprotected

Get group membership mappings that are managed by this storage provider

戻り値

                                                  {
        return Collections.EMPTY_SET;
    }

getId()

String org.keycloak.storage.adapter.AbstractUserAdapter.getId ( )

inline

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

戻り値

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

                          {
        if (storageId == null) {
            storageId = new StorageId(storageProviderModel.getId(), getUsername());
        }
        return storageId.getId();
    }

getLastName()

String org.keycloak.storage.adapter.AbstractUserAdapter.getLastName ( )

inline

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

                                {
        return null;
    }

getRealmRoleMappings()

Set<RoleModel> org.keycloak.storage.adapter.AbstractUserAdapter.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.storage.adapter.AbstractUserAdapter.getRequiredActions ( )

inline

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

                                            {
        return Collections.EMPTY_SET;
    }

getRoleMappings()

Set<RoleModel> org.keycloak.storage.adapter.AbstractUserAdapter.getRoleMappings ( )

inline

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

                                            {
        Set<RoleModel> set = new HashSet<>();
        if (appendDefaultRolesToRoleMappings()) set.addAll(DefaultRoles.getDefaultRoles(realm));
        set.addAll(getRoleMappingsInternal());
        return set;
    }

getRoleMappingsInternal()

Set<RoleModel> org.keycloak.storage.adapter.AbstractUserAdapter.getRoleMappingsInternal ( )

inlineprotected

                                                       {
        return Collections.EMPTY_SET;
    }

getServiceAccountClientLink()

String org.keycloak.storage.adapter.AbstractUserAdapter.getServiceAccountClientLink ( )

inline

This method should not be overriden

戻り値

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

                                                {
        return null;
    }

getUsername()

String org.keycloak.models.UserModel.getUsername ( )

inherited

org.keycloak.storage.adapter.InMemoryUserAdapter, org.keycloak.models.cache.infinispan.UserAdapter, org.keycloak.models.jpa.UserAdapter, org.keycloak.models.utils.UserModelDelegateで実装されています。

grantRole()

void org.keycloak.storage.adapter.AbstractUserAdapter.grantRole ( RoleModel  role )

inline

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

                                          {
        throw new ReadOnlyException("user is read only for this update");

    }

hashCode()

int org.keycloak.storage.adapter.AbstractUserAdapter.hashCode ( )

inline

                          {
        return getId().hashCode();
    }

hasRole()

boolean org.keycloak.storage.adapter.AbstractUserAdapter.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.storage.adapter.AbstractUserAdapter.isEmailVerified ( )

inline

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

                                     {
        return false;
    }

isEnabled()

boolean org.keycloak.storage.adapter.AbstractUserAdapter.isEnabled ( )

inline

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

                               {
        return true;
    }

isMemberOf()

boolean org.keycloak.storage.adapter.AbstractUserAdapter.isMemberOf ( GroupModel  group )

inline

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

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

joinGroup()

void org.keycloak.storage.adapter.AbstractUserAdapter.joinGroup ( GroupModel  group )

inline

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

                                            {
        throw new ReadOnlyException("user is read only for this update");

    }

leaveGroup()

void org.keycloak.storage.adapter.AbstractUserAdapter.leaveGroup ( GroupModel  group )

inline

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

                                             {
        throw new ReadOnlyException("user is read only for this update");

    }

removeAttribute()

void org.keycloak.storage.adapter.AbstractUserAdapter.removeAttribute ( String  name )

inline

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

                                             {
        throw new ReadOnlyException("user is read only for this update");

    }

removeRequiredAction() [1/2]

void org.keycloak.storage.adapter.AbstractUserAdapter.removeRequiredAction ( String  action )

inline

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

                                                    {
        throw new ReadOnlyException("user is read only for this update");

    }

removeRequiredAction() [2/2]

void org.keycloak.storage.adapter.AbstractUserAdapter.removeRequiredAction ( RequiredAction  action )

inline

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

                                                            {
        throw new ReadOnlyException("user is read only for this update");
    }

setAttribute()

void org.keycloak.storage.adapter.AbstractUserAdapter.setAttribute ( String  name, List< String >  values  )

inline

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

                                                               {
        throw new ReadOnlyException("user is read only for this update");

    }

setCreatedTimestamp()

void org.keycloak.storage.adapter.AbstractUserAdapter.setCreatedTimestamp ( Long  timestamp )

inline

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

                                                    {
        throw new ReadOnlyException("user is read only for this update");

    }

setEmail()

void org.keycloak.storage.adapter.AbstractUserAdapter.setEmail ( String  email )

inline

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

                                       {
        throw new ReadOnlyException("user is read only for this update");

    }

setEmailVerified()

void org.keycloak.storage.adapter.AbstractUserAdapter.setEmailVerified ( boolean  verified )

inline

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

                                                   {
        throw new ReadOnlyException("user is read only for this update");

    }

setEnabled()

void org.keycloak.storage.adapter.AbstractUserAdapter.setEnabled ( boolean  enabled )

inline

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

                                            {
        throw new ReadOnlyException("user is read only for this update");
    }

setFederationLink()

void org.keycloak.storage.adapter.AbstractUserAdapter.setFederationLink ( String  link )

inline

This method should not be overriden

戻り値

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

                                               {
        throw new ReadOnlyException("user is read only for this update");

    }

setFirstName()

void org.keycloak.storage.adapter.AbstractUserAdapter.setFirstName ( String  firstName )

inline

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

                                               {
        throw new ReadOnlyException("user is read only for this update");

    }

setLastName()

void org.keycloak.storage.adapter.AbstractUserAdapter.setLastName ( String  lastName )

inline

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

                                             {
        throw new ReadOnlyException("user is read only for this update");

    }

setServiceAccountClientLink()

void org.keycloak.storage.adapter.AbstractUserAdapter.setServiceAccountClientLink ( String  clientInternalId )

inline

This method should not be overriden

戻り値

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

                                                                     {
        throw new ReadOnlyException("user is read only for this update");

    }

setSingleAttribute()

void org.keycloak.storage.adapter.AbstractUserAdapter.setSingleAttribute ( String  name, String  value  )

inline

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

                                                              {
        throw new ReadOnlyException("user is read only for this update");

    }

setUsername()

void org.keycloak.storage.adapter.AbstractUserAdapter.setUsername ( String  username )

inline

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

                                             {
        throw new ReadOnlyException("user is read only for this update");
    }

メンバ詳解

created

long org.keycloak.storage.adapter.AbstractUserAdapter.created = System.currentTimeMillis()

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.storage.adapter.AbstractUserAdapter.realm

protected

session

KeycloakSession org.keycloak.storage.adapter.AbstractUserAdapter.session

protected

storageId

StorageId org.keycloak.storage.adapter.AbstractUserAdapter.storageId

protected

storageProviderModel

ComponentModel org.keycloak.storage.adapter.AbstractUserAdapter.storageProviderModel

protected

USERNAME

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

inherited

---

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

• D:/AppData/doxygen/keycloak/src/keycloak/src/main/java/org/keycloak/storage/adapter/AbstractUserAdapter.java