org.keycloak.partialimport.RolesPartialImport クラス

org.keycloak.partialimport.RolesPartialImport の継承関係図

org.keycloak.partialimport.RolesPartialImport 連携図

公開メンバ関数
void	prepare (PartialImportRepresentation rep, RealmModel realm, KeycloakSession session) throws ErrorResponseException
void	removeOverwrites (RealmModel realm, KeycloakSession session)
PartialImportResults	doImport (PartialImportRepresentation rep, RealmModel realm, KeycloakSession session) throws ErrorResponseException

非公開メンバ関数
void	prepareRealmRoles (PartialImportRepresentation rep, RealmModel realm, KeycloakSession session) throws ErrorResponseException
void	prepareClientRoles (PartialImportRepresentation rep, RealmModel realm, KeycloakSession session) throws ErrorResponseException
void	setUniqueIds (List< RoleRepresentation > realmRoles)
void	setUniqueIds (Map< String, List< RoleRepresentation >> clientRoles)
void	removeRealmRoleSkips (PartialImportResults results, PartialImportRepresentation rep, RealmModel realm, KeycloakSession session)
void	removeClientRoleSkips (PartialImportResults results, PartialImportRepresentation rep, RealmModel realm)
void	deleteRealmRoleOverwrites (RealmModel realm, KeycloakSession session)
void	addResultsForOverwrittenRealmRoles (PartialImportResults results, RealmModel realm, KeycloakSession session)
void	deleteClientRoleOverwrites (RealmModel realm)
void	addResultsForOverwrittenClientRoles (PartialImportResults results, RealmModel realm)
boolean	isEmpty (Set set)
boolean	isEmpty (Map map)
void	realmRoleAdds (PartialImportResults results, PartialImportRepresentation rep, RealmModel realm, KeycloakSession session)
void	clientRoleAdds (PartialImportResults results, PartialImportRepresentation rep, RealmModel realm)

非公開変数類
Set< RoleRepresentation >	realmRolesToOverwrite
Set< RoleRepresentation >	realmRolesToSkip
Map< String, Set< RoleRepresentation > >	clientRolesToOverwrite
Map< String, Set< RoleRepresentation > >	clientRolesToSkip
final RealmRolesPartialImport	realmRolesPI = new RealmRolesPartialImport()
final ClientRolesPartialImport	clientRolesPI = new ClientRolesPartialImport()

詳解

This class handles both realm roles and client roles. It delegates to RealmRolesPartialImport and ClientRolesPartialImport, which are no longer used directly by the PartialImportManager.

The strategy is to utilize RepresentationToModel.importRoles(). That way, the complex code for bulk creation of roles is kept in one place. To do this, the logic for skip needs to remove the roles that are going to be skipped so that importRoles() doesn't know about them. The logic for overwrite needs to delete the overwritten roles before importRoles() is called.

著者

Stan Silvert ssilv.nosp@m.ert@.nosp@m.redha.nosp@m.t.co.nosp@m.m (C) 2016 Red Hat Inc.

関数詳解

addResultsForOverwrittenClientRoles()

void org.keycloak.partialimport.RolesPartialImport.addResultsForOverwrittenClientRoles ( PartialImportResults  results, RealmModel  realm  )

inlineprivate

                                                                                                     {
        if (isEmpty(clientRolesToOverwrite)) return;

        for (String clientId : clientRolesToOverwrite.keySet()) {
            for (RoleRepresentation roleRep : clientRolesToOverwrite.get(clientId)) {
                String modelId = clientRolesPI.getModelId(realm, clientId);
                results.addResult(clientRolesPI.overwritten(clientId, modelId, roleRep));
            }
        }
    }

addResultsForOverwrittenRealmRoles()

void org.keycloak.partialimport.RolesPartialImport.addResultsForOverwrittenRealmRoles ( PartialImportResults  results, RealmModel  realm, KeycloakSession  session  )

inlineprivate

                                                                                                                             {
        if (isEmpty(realmRolesToOverwrite)) return;

        for (RoleRepresentation roleRep : realmRolesToOverwrite) {
            String modelId = realmRolesPI.getModelId(realm, session, roleRep);
            results.addResult(realmRolesPI.overwritten(modelId, roleRep));
        }
    }

clientRoleAdds()

void org.keycloak.partialimport.RolesPartialImport.clientRoleAdds ( PartialImportResults  results, PartialImportRepresentation  rep, RealmModel  realm  )

inlineprivate

                                                  {
        if (!rep.hasClientRoles()) return;

        Map<String, List<RoleRepresentation>> repList = clientRolesPI.getRepList(rep);
        for (String clientId : repList.keySet()) {
            for (RoleRepresentation roleRep : repList.get(clientId)) {
                if (clientRolesToOverwrite.get(clientId).contains(roleRep)) continue;
                if (clientRolesToSkip.get(clientId).contains(roleRep)) continue;

                String modelId = clientRolesPI.getModelId(realm, clientId);
                results.addResult(clientRolesPI.added(clientId, modelId, roleRep));
            }
        }
    }

deleteClientRoleOverwrites()

void org.keycloak.partialimport.RolesPartialImport.deleteClientRoleOverwrites ( RealmModel  realm )

inlineprivate

                                                              {
        if (isEmpty(clientRolesToOverwrite)) return;

        for (String clientId : clientRolesToOverwrite.keySet()) {
            for (RoleRepresentation roleRep : clientRolesToOverwrite.get(clientId)) {
                clientRolesPI.deleteRole(realm, clientId, roleRep);
            }
        }
    }

deleteRealmRoleOverwrites()

void org.keycloak.partialimport.RolesPartialImport.deleteRealmRoleOverwrites ( RealmModel  realm, KeycloakSession  session  )

inlineprivate

                                                                                      {
        if (isEmpty(realmRolesToOverwrite)) return;

        for (RoleRepresentation roleRep : realmRolesToOverwrite) {
            realmRolesPI.remove(realm, session, roleRep);
        }
    }

doImport()

PartialImportResults org.keycloak.partialimport.RolesPartialImport.doImport ( PartialImportRepresentation  rep, RealmModel  realm, KeycloakSession  session  ) throws ErrorResponseException

inline

                                                                                                                                                   {
        PartialImportResults results = new PartialImportResults();
        if (!rep.hasRealmRoles() && !rep.hasClientRoles()) return results;

        // finalize preparation and add results for skips
        removeRealmRoleSkips(results, rep, realm, session);
        removeClientRoleSkips(results, rep, realm);
        if (rep.hasRealmRoles()) setUniqueIds(rep.getRoles().getRealm());
        if (rep.hasClientRoles()) setUniqueIds(rep.getRoles().getClient());

        try {
            RepresentationToModel.importRoles(rep.getRoles(), realm);
        } catch (Exception e) {
            ServicesLogger.LOGGER.roleImportError(e);
            throw new ErrorResponseException(ErrorResponse.error(e.getMessage(), Response.Status.INTERNAL_SERVER_ERROR));
        }

        // add "add" results for new roles created
        realmRoleAdds(results, rep, realm, session);
        clientRoleAdds(results, rep, realm);

        // add "overwritten" results for roles overwritten
        addResultsForOverwrittenRealmRoles(results, realm, session);
        addResultsForOverwrittenClientRoles(results, realm);

        return results;
    }

isEmpty() [1/2]

boolean org.keycloak.partialimport.RolesPartialImport.isEmpty ( Set  set )

inlineprivate

                                     {
        return (set == null) || (set.isEmpty());
    }

isEmpty() [2/2]

boolean org.keycloak.partialimport.RolesPartialImport.isEmpty ( Map  map )

inlineprivate

                                     {
        return (map == null) || (map.isEmpty());
    }

prepare()

void org.keycloak.partialimport.RolesPartialImport.prepare ( PartialImportRepresentation  rep, RealmModel  realm, KeycloakSession  session  ) throws ErrorResponseException

inline

                                                                                                                                  {
        prepareRealmRoles(rep, realm, session);
        prepareClientRoles(rep, realm, session);
    }

prepareClientRoles()

void org.keycloak.partialimport.RolesPartialImport.prepareClientRoles ( PartialImportRepresentation  rep, RealmModel  realm, KeycloakSession  session  ) throws ErrorResponseException

inlineprivate

                                                                                                                                              {
        if (!rep.hasClientRoles()) return;

        clientRolesPI.prepare(rep, realm, session);
        this.clientRolesToOverwrite = clientRolesPI.getToOverwrite();
        this.clientRolesToSkip = clientRolesPI.getToSkip();
    }

prepareRealmRoles()

void org.keycloak.partialimport.RolesPartialImport.prepareRealmRoles ( PartialImportRepresentation  rep, RealmModel  realm, KeycloakSession  session  ) throws ErrorResponseException

inlineprivate

                                                                                                                                             {
        if (!rep.hasRealmRoles()) return;

        realmRolesPI.prepare(rep, realm, session);
        this.realmRolesToOverwrite = realmRolesPI.getToOverwrite();
        this.realmRolesToSkip = realmRolesPI.getToSkip();
    }

realmRoleAdds()

void org.keycloak.partialimport.RolesPartialImport.realmRoleAdds ( PartialImportResults  results, PartialImportRepresentation  rep, RealmModel  realm, KeycloakSession  session  )

inlineprivate

                                                        {
        if (!rep.hasRealmRoles()) return;

        for (RoleRepresentation roleRep : rep.getRoles().getRealm()) {
            if (realmRolesToOverwrite.contains(roleRep)) continue;
            if (realmRolesToSkip.contains(roleRep)) continue;

            String modelId = realmRolesPI.getModelId(realm, session, roleRep);
            results.addResult(realmRolesPI.added(modelId, roleRep));
        }
    }

removeClientRoleSkips()

void org.keycloak.partialimport.RolesPartialImport.removeClientRoleSkips ( PartialImportResults  results, PartialImportRepresentation  rep, RealmModel  realm  )

inlineprivate

                                                         {
        if (isEmpty(clientRolesToSkip)) return;

        for (String clientId : clientRolesToSkip.keySet()) {
            for (RoleRepresentation roleRep : clientRolesToSkip.get(clientId)) {
                rep.getRoles().getClient().get(clientId).remove(roleRep);
                String modelId = clientRolesPI.getModelId(realm, clientId);
                results.addResult(clientRolesPI.skipped(clientId, modelId, roleRep));
            }
        }
    }

removeOverwrites()

void org.keycloak.partialimport.RolesPartialImport.removeOverwrites ( RealmModel  realm, KeycloakSession  session  )

inline

                                                                            {
        deleteClientRoleOverwrites(realm);
        deleteRealmRoleOverwrites(realm, session);
    }

removeRealmRoleSkips()

void org.keycloak.partialimport.RolesPartialImport.removeRealmRoleSkips ( PartialImportResults  results, PartialImportRepresentation  rep, RealmModel  realm, KeycloakSession  session  )

inlineprivate

                                                               {
        if (isEmpty(realmRolesToSkip)) return;

        for (RoleRepresentation roleRep : realmRolesToSkip) {
            rep.getRoles().getRealm().remove(roleRep);
            String modelId = realmRolesPI.getModelId(realm, session, roleRep);
            results.addResult(realmRolesPI.skipped(modelId, roleRep));
        }
    }

setUniqueIds() [1/2]

void org.keycloak.partialimport.RolesPartialImport.setUniqueIds ( List< RoleRepresentation >  realmRoles )

inlineprivate

                                                                   {
        for (RoleRepresentation realmRole : realmRoles) {
            realmRole.setId(KeycloakModelUtils.generateId());
        }
    }

setUniqueIds() [2/2]

void org.keycloak.partialimport.RolesPartialImport.setUniqueIds ( Map< String, List< RoleRepresentation >>  clientRoles )

inlineprivate

                                                                                 {
        for (String clientId : clientRoles.keySet()) {
            for (RoleRepresentation clientRole : clientRoles.get(clientId)) {
                clientRole.setId(KeycloakModelUtils.generateId());
            }
        }
    }

メンバ詳解

clientRolesPI

final ClientRolesPartialImport org.keycloak.partialimport.RolesPartialImport.clientRolesPI = new ClientRolesPartialImport()

private

clientRolesToOverwrite

Map<String, Set<RoleRepresentation> > org.keycloak.partialimport.RolesPartialImport.clientRolesToOverwrite

private

clientRolesToSkip

Map<String, Set<RoleRepresentation> > org.keycloak.partialimport.RolesPartialImport.clientRolesToSkip

private

realmRolesPI

final RealmRolesPartialImport org.keycloak.partialimport.RolesPartialImport.realmRolesPI = new RealmRolesPartialImport()

private

realmRolesToOverwrite

Set<RoleRepresentation> org.keycloak.partialimport.RolesPartialImport.realmRolesToOverwrite

private

realmRolesToSkip

Set<RoleRepresentation> org.keycloak.partialimport.RolesPartialImport.realmRolesToSkip

private

---

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

• D:/AppData/doxygen/keycloak/rest-service/src/services/src/main/java/org/keycloak/partialimport/RolesPartialImport.java