org.keycloak.migration.migrators.MigrationUtils クラス

org.keycloak.migration.migrators.MigrationUtils 連携図

静的公開メンバ関数
static void	addAdminRole (RealmModel realm, String roleName)
static void	updateOTPRequiredAction (RequiredActionProviderModel otpAction)
static void	updateProtocolMappers (ProtocolMapperContainerModel client)
static void	migrateOldOfflineToken (KeycloakSession session, RealmModel realm, ClientModel client, UserModel user) throws OAuthErrorException

詳解

著者

Stian Thorgersen

関数詳解

addAdminRole()

static void org.keycloak.migration.migrators.MigrationUtils.addAdminRole ( RealmModel  realm, String  roleName  )

inlinestatic

                                                                       {
        ClientModel client = realm.getMasterAdminClient();
        if (client != null && client.getRole(roleName) == null) {
            RoleModel role = client.addRole(roleName);
            role.setDescription("${role_" + roleName + "}");

            client.getRealm().getRole(AdminRoles.ADMIN).addCompositeRole(role);
        }

        if (!realm.getName().equals(Config.getAdminRealm())) {
            client = realm.getClientByClientId(Constants.REALM_MANAGEMENT_CLIENT_ID);
            if (client != null && client.getRole(roleName) == null) {
                RoleModel role = client.addRole(roleName);
                role.setDescription("${role_" + roleName + "}");

                client.getRole(AdminRoles.REALM_ADMIN).addCompositeRole(role);
            }
        }
    }

migrateOldOfflineToken()

static void org.keycloak.migration.migrators.MigrationUtils.migrateOldOfflineToken ( KeycloakSession  session, RealmModel  realm, ClientModel  client, UserModel  user  ) throws OAuthErrorException

inlinestatic

                                                                                                                                                        {
        ClientScopeModel offlineScope = KeycloakModelUtils.getClientScopeByName(realm, OAuth2Constants.OFFLINE_ACCESS);
        if (offlineScope == null) {
            throw new OAuthErrorException(OAuthErrorException.INVALID_GRANT, "Offline Access scope not found");
        }

        if (client.isConsentRequired()) {
            // Automatically add consents for client and for offline_access. We know that both were defacto approved by user already and offlineSession is still valid
            UserConsentModel consent = session.users().getConsentByClient(realm, user.getId(), client.getId());
            if (consent != null) {
                if (client.isDisplayOnConsentScreen()) {
                    consent.addGrantedClientScope(client);
                }
                if (offlineScope.isDisplayOnConsentScreen()) {
                    consent.addGrantedClientScope(offlineScope);
                }
                session.users().updateConsent(realm, user.getId(), consent);
            }
        }
    }

updateOTPRequiredAction()

static void org.keycloak.migration.migrators.MigrationUtils.updateOTPRequiredAction ( RequiredActionProviderModel  otpAction )

inlinestatic

                                                                                      {
        if (otpAction == null) return;
        if (!UserModel.RequiredAction.CONFIGURE_TOTP.name().equals(otpAction.getProviderId())) return;
        if (!"Configure Totp".equals(otpAction.getName())) return;

        otpAction.setName("Configure OTP");
    }

updateProtocolMappers()

static void org.keycloak.migration.migrators.MigrationUtils.updateProtocolMappers ( ProtocolMapperContainerModel  client )

inlinestatic

                                                                                  {
        List<ProtocolMapperModel> toUpdate = new LinkedList<>();
        for (ProtocolMapperModel mapper : client.getProtocolMappers()) {
            if (!mapper.getConfig().containsKey("userinfo.token.claim") && mapper.getConfig().containsKey("id.token.claim")) {
                mapper.getConfig().put("userinfo.token.claim", mapper.getConfig().get("id.token.claim"));
                toUpdate.add(mapper);
            }
        }

        for (ProtocolMapperModel mapper : toUpdate) {
            client.updateProtocolMapper(mapper);
        }
    }

---

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

• D:/AppData/doxygen/keycloak/src/keycloak/src/main/java/org/keycloak/migration/migrators/MigrationUtils.java