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

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

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

公開メンバ関数
	AbstractUserAdapterFederatedStorage (KeycloakSession session, RealmModel realm, ComponentModel storageProviderModel)
UserFederatedStorageProvider	getFederatedStorage ()
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 ()
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 ()
void	setUsername (String username)

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

静的公開変数類
static String	FIRST_NAME_ATTRIBUTE = "FIRST_NAME"
static String	LAST_NAME_ATTRIBUTE = "LAST_NAME"
static String	EMAIL_ATTRIBUTE = "EMAIL"
static String	EMAIL_VERIFIED_ATTRIBUTE = "EMAIL_VERIFIED"
static String	CREATED_TIMESTAMP_ATTRIBUTE = "CREATED_TIMESTAMP"
static String	ENABLED_ATTRIBUTE = "ENABLED"

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

限定公開変数類
KeycloakSession	session
RealmModel	realm
ComponentModel	storageProviderModel
StorageId	storageId

詳解

Assumes everything is managed by federated storage except for username. getId() returns a default value of "f:" + providerId + ":" + getUsername(). UserModel properties like enabled, firstName, lastName, email, etc. are all stored as attributes in federated storage.

isEnabled() defaults to true if the ENABLED_ATTRIBUTE isn't set in federated storage

著者

Bill Burke

バージョン

Revision

1

構築子と解体子

AbstractUserAdapterFederatedStorage()

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

inline

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

関数詳解

addRequiredAction() [1/2]

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

inline

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

                                                 {
        getFederatedStorage().addRequiredAction(realm, this.getId(), action);

    }

addRequiredAction() [2/2]

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

inline

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

                                                         {
        getFederatedStorage().addRequiredAction(realm, this.getId(), action.name());

    }

appendDefaultGroups()

boolean org.keycloak.storage.adapter.AbstractUserAdapterFederatedStorage.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.AbstractUserAdapterFederatedStorage.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.AbstractUserAdapterFederatedStorage.deleteRoleMapping ( RoleModel  role )

inline

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

                                                  {
        getFederatedStorage().deleteRoleMapping(realm, this.getId(), role);

    }

equals()

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

inline

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

                                                  {
        return getFederatedStorage().getAttributes(realm, this.getId()).get(name);
    }

getAttributes()

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

inline

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

                                                     {
        return getFederatedStorage().getAttributes(realm, this.getId());
    }

getClientRoleMappings()

Set<RoleModel> org.keycloak.storage.adapter.AbstractUserAdapterFederatedStorage.getClientRoleMappings ( ClientModel  app )

inline

Gets role mappings from federated storage and automatically appends default roles. Also calls getRoleMappingsInternal() method to pull role mappings from provider. Implementors can override that method

戻り値

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.AbstractUserAdapterFederatedStorage.getCreatedTimestamp ( )

inline

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

                                      {
        String val = getFirstAttribute(CREATED_TIMESTAMP_ATTRIBUTE);
        if (val == null) return null;
        else return Long.valueOf(val);
    }

getEmail()

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

inline

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

                             {
        return getFirstAttribute(EMAIL_ATTRIBUTE);
    }

getFederatedRoleMappings()

Set<RoleModel> org.keycloak.storage.adapter.AbstractUserAdapterFederatedStorage.getFederatedRoleMappings ( )

inlineprotected

                                                        {
        return getFederatedStorage().getRoleMappings(realm, this.getId());
    }

getFederatedStorage()

UserFederatedStorageProvider org.keycloak.storage.adapter.AbstractUserAdapterFederatedStorage.getFederatedStorage ( )

inline

                                                              {
        return session.userFederatedStorage();
    }

getFederationLink()

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

inline

This method should not be overriden

戻り値

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

                                      {
        return null;
    }

getFirstAttribute()

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

inline

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

                                                 {
        return getFederatedStorage().getAttributes(realm, this.getId()).getFirst(name);
    }

getFirstName()

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

inline

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

                                 {
        return getFirstAttribute(FIRST_NAME_ATTRIBUTE);
    }

getGroups()

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

inline

Gets groups from federated storage and automatically appends default groups of realm. Also calls getGroupsInternal() method to pull group membership from provider. Implementors can override that method

戻り値

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

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

getGroupsInternal()

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

inlineprotected

Get group membership mappings that are managed by this storage provider

戻り値

                                                  {
        return Collections.EMPTY_SET;
    }

getId()

String org.keycloak.storage.adapter.AbstractUserAdapterFederatedStorage.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.AbstractUserAdapterFederatedStorage.getLastName ( )

inline

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

                                {
        return getFirstAttribute(LAST_NAME_ATTRIBUTE);
    }

getRealmRoleMappings()

Set<RoleModel> org.keycloak.storage.adapter.AbstractUserAdapterFederatedStorage.getRealmRoleMappings ( )

inline

Gets role mappings from federated storage and automatically appends default roles. Also calls getRoleMappingsInternal() method to pull role mappings from provider. Implementors can override that method

戻り値

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.AbstractUserAdapterFederatedStorage.getRequiredActions ( )

inline

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

                                            {
        return getFederatedStorage().getRequiredActions(realm, this.getId());
    }

getRoleMappings()

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

inline

Gets role mappings from federated storage and automatically appends default roles. Also calls getRoleMappingsInternal() method to pull role mappings from provider. Implementors can override that method

戻り値

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

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

getRoleMappingsInternal()

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

inlineprotected

                                                       {
        return Collections.EMPTY_SET;
    }

getServiceAccountClientLink()

String org.keycloak.storage.adapter.AbstractUserAdapterFederatedStorage.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.utils.UserModelDelegateで実装されています。

grantRole()

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

inline

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

                                          {
        getFederatedStorage().grantRole(realm, this.getId(), role);

    }

hashCode()

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

inline

                          {
        return getId().hashCode();
    }

hasRole()

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

inline

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

                                     {
        String val = getFirstAttribute(EMAIL_VERIFIED_ATTRIBUTE);
        if (val == null) return false;
        else return Boolean.valueOf(val);
    }

isEnabled()

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

inline

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

                               {
        String val = getFirstAttribute(ENABLED_ATTRIBUTE);
        if (val == null) return true;
        else return Boolean.valueOf(val);
    }

isMemberOf()

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

inline

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

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

joinGroup()

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

inline

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

                                            {
        getFederatedStorage().joinGroup(realm, this.getId(), group);

    }

leaveGroup()

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

inline

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

                                             {
        getFederatedStorage().leaveGroup(realm, this.getId(), group);

    }

removeAttribute()

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

inline

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

                                             {
        getFederatedStorage().removeAttribute(realm, this.getId(), name);

    }

removeRequiredAction() [1/2]

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

inline

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

                                                    {
        getFederatedStorage().removeRequiredAction(realm, this.getId(), action);

    }

removeRequiredAction() [2/2]

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

inline

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

                                                            {
        getFederatedStorage().removeRequiredAction(realm, this.getId(), action.name());
    }

setAttribute()

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

inline

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

                                                               {
        getFederatedStorage().setAttribute(realm, this.getId(), name, values);

    }

setCreatedTimestamp()

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

inline

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

                                                    {
        if (timestamp == null) {
            setSingleAttribute(CREATED_TIMESTAMP_ATTRIBUTE, null);
        } else {
            setSingleAttribute(CREATED_TIMESTAMP_ATTRIBUTE, Long.toString(timestamp));
        }

    }

setEmail()

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

inline

Stores as attribute in federated storage. EMAIL_ATTRIBUTE

引数

email

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

                                       {
        setSingleAttribute(EMAIL_ATTRIBUTE, email);

    }

setEmailVerified()

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

inline

Stores as attribute in federated storage. EMAIL_VERIFIED_ATTRIBUTE

引数

verified

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

                                                   {
        setSingleAttribute(EMAIL_VERIFIED_ATTRIBUTE, Boolean.toString(verified));

    }

setEnabled()

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

inline

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

                                            {
       setSingleAttribute(ENABLED_ATTRIBUTE, Boolean.toString(enabled));
    }

setFederationLink()

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

inline

This method should not be overriden

戻り値

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

                                               {

    }

setFirstName()

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

inline

Stores as attribute in federated storage. FIRST_NAME_ATTRIBUTE

引数

firstName

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

                                               {
        setSingleAttribute(FIRST_NAME_ATTRIBUTE, firstName);

    }

setLastName()

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

inline

Stores as attribute in federated storage. LAST_NAME_ATTRIBUTE

引数

lastName

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

                                             {
        setSingleAttribute(LAST_NAME_ATTRIBUTE, lastName);

    }

setServiceAccountClientLink()

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

inline

This method should not be overriden

戻り値

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

                                                                     {

    }

setSingleAttribute()

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

inline

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

                                                              {
        getFederatedStorage().setSingleAttribute(realm, this.getId(), name, value);

    }

setUsername()

void org.keycloak.models.UserModel.setUsername ( String  username )

inherited

org.keycloak.storage.adapter.AbstractUserAdapter, org.keycloak.storage.adapter.InMemoryUserAdapter, org.keycloak.models.utils.UserModelDelegate, org.keycloak.models.utils.ReadOnlyUserModelDelegateで実装されています。

メンバ詳解

CREATED_TIMESTAMP_ATTRIBUTE

String org.keycloak.storage.adapter.AbstractUserAdapterFederatedStorage.CREATED_TIMESTAMP_ATTRIBUTE = "CREATED_TIMESTAMP"

static

EMAIL

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

inherited

EMAIL_ATTRIBUTE

String org.keycloak.storage.adapter.AbstractUserAdapterFederatedStorage.EMAIL_ATTRIBUTE = "EMAIL"

static

EMAIL_VERIFIED_ATTRIBUTE

String org.keycloak.storage.adapter.AbstractUserAdapterFederatedStorage.EMAIL_VERIFIED_ATTRIBUTE = "EMAIL_VERIFIED"

static

ENABLED_ATTRIBUTE

String org.keycloak.storage.adapter.AbstractUserAdapterFederatedStorage.ENABLED_ATTRIBUTE = "ENABLED"

static

FIRST_NAME

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

inherited

FIRST_NAME_ATTRIBUTE

String org.keycloak.storage.adapter.AbstractUserAdapterFederatedStorage.FIRST_NAME_ATTRIBUTE = "FIRST_NAME"

static

LAST_NAME

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

inherited

LAST_NAME_ATTRIBUTE

String org.keycloak.storage.adapter.AbstractUserAdapterFederatedStorage.LAST_NAME_ATTRIBUTE = "LAST_NAME"

static

LOCALE

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

inherited

realm

RealmModel org.keycloak.storage.adapter.AbstractUserAdapterFederatedStorage.realm

protected

session

KeycloakSession org.keycloak.storage.adapter.AbstractUserAdapterFederatedStorage.session

protected

storageId

StorageId org.keycloak.storage.adapter.AbstractUserAdapterFederatedStorage.storageId

protected

storageProviderModel

ComponentModel org.keycloak.storage.adapter.AbstractUserAdapterFederatedStorage.storageProviderModel

protected

USERNAME

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

inherited

---

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

• D:/AppData/doxygen/keycloak/oidc-service/src/main/java/org/keycloak/storage/adapter/AbstractUserAdapterFederatedStorage.java