org.keycloak.partialimport.ClientRolesPartialImport クラス

org.keycloak.partialimport.ClientRolesPartialImport 連携図

公開メンバ関数
Map< String, Set< RoleRepresentation > >	getToOverwrite ()
Map< String, Set< RoleRepresentation > >	getToSkip ()
Map< String, List< RoleRepresentation > >	getRepList (PartialImportRepresentation partialImportRep)
String	getName (RoleRepresentation roleRep)
String	getCombinedName (String clientId, RoleRepresentation roleRep)
boolean	exists (RealmModel realm, KeycloakSession session, String clientId, RoleRepresentation roleRep)
String	existsMessage (String clientId, RoleRepresentation roleRep)
ResourceType	getResourceType ()
void	deleteRole (RealmModel realm, String clientId, RoleRepresentation roleRep)
void	prepare (PartialImportRepresentation partialImportRep, RealmModel realm, KeycloakSession session) throws ErrorResponseException
PartialImportResult	overwritten (String clientId, String modelId, RoleRepresentation roleRep)
PartialImportResult	skipped (String clientId, String modelId, RoleRepresentation roleRep)
PartialImportResult	added (String clientId, String modelId, RoleRepresentation roleRep)
String	getModelId (RealmModel realm, String clientId)

限定公開メンバ関数
ErrorResponseException	exists (String message)
ErrorResponseException	noClientFound (String clientId)

非公開メンバ関数
boolean	clientExists (PartialImportRepresentation partialImportRep, RealmModel realm, String clientId)

非公開変数類
final Map< String, Set< RoleRepresentation > >	toOverwrite = new HashMap<>()
final Map< String, Set< RoleRepresentation > >	toSkip = new HashMap<>()

詳解

Partial Import handler for Client Roles.

著者

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

関数詳解

added()

PartialImportResult org.keycloak.partialimport.ClientRolesPartialImport.added ( String  clientId, String  modelId, RoleRepresentation  roleRep  )

inline

                                                                                                  {
        return PartialImportResult.added(getResourceType(), getCombinedName(clientId, roleRep), modelId, roleRep);
    }

clientExists()

boolean org.keycloak.partialimport.ClientRolesPartialImport.clientExists ( PartialImportRepresentation  partialImportRep, RealmModel  realm, String  clientId  )

inlineprivate

                                                                                                                  {
        if (realm.getClientByClientId(clientId) != null) return true;

        if (partialImportRep.getClients() == null) return false;

        for (ClientRepresentation client : partialImportRep.getClients()) {
            if (clientId.equals(client.getClientId())) return true;
        }

        return false;
    }

deleteRole()

void org.keycloak.partialimport.ClientRolesPartialImport.deleteRole ( RealmModel  realm, String  clientId, RoleRepresentation  roleRep  )

inline

                                                                                          {
        ClientModel client = realm.getClientByClientId(clientId);
        if (client == null) {
            // client might have been removed as part of this partial import
            return;
        }
        RoleModel role = client.getRole(getName(roleRep));
        if (role == null) {
            // role might not exist if client was just created as part of the
            // partial import
            return;
        }
        client.removeRole(role);
    }

exists() [1/2]

boolean org.keycloak.partialimport.ClientRolesPartialImport.exists ( RealmModel  realm, KeycloakSession  session, String  clientId, RoleRepresentation  roleRep  )

inline

                                                                                                                  {
        ClientModel client = realm.getClientByClientId(clientId);
        if (client == null) return false;

        for (RoleModel role : client.getRoles()) {
            if (getName(roleRep).equals(role.getName())) return true;
        }

        return false;
    }

exists() [2/2]

ErrorResponseException org.keycloak.partialimport.ClientRolesPartialImport.exists ( String  message )

inlineprotected

                                                            {
        Response error = ErrorResponse.exists(message);
        return new ErrorResponseException(error);
    }

existsMessage()

String org.keycloak.partialimport.ClientRolesPartialImport.existsMessage ( String  clientId, RoleRepresentation  roleRep  )

inline

                                                                             {
        return "Client role '" + getName(roleRep) + "' for client '" + clientId + "' already exists.";
    }

getCombinedName()

String org.keycloak.partialimport.ClientRolesPartialImport.getCombinedName ( String  clientId, RoleRepresentation  roleRep  )

inline

                                                                               {
        return clientId + "-->" + getName(roleRep);
    }

getModelId()

String org.keycloak.partialimport.ClientRolesPartialImport.getModelId ( RealmModel  realm, String  clientId  )

inline

                                                                {
        return realm.getClientByClientId(clientId).getId();
    }

getName()

String org.keycloak.partialimport.ClientRolesPartialImport.getName ( RoleRepresentation  roleRep )

inline

                                                      {
        if (roleRep.getName() == null)
            throw new IllegalStateException("Client role to import does not have a name");
        return roleRep.getName();
    }

getRepList()

Map<String, List<RoleRepresentation> > org.keycloak.partialimport.ClientRolesPartialImport.getRepList ( PartialImportRepresentation  partialImportRep )

inline

                                                                                                          {
        if (partialImportRep.getRoles() == null) return null;
        return partialImportRep.getRoles().getClient();
    }

getResourceType()

ResourceType org.keycloak.partialimport.ClientRolesPartialImport.getResourceType ( )

inline

                                          {
        return ResourceType.CLIENT_ROLE;
    }

getToOverwrite()

Map<String, Set<RoleRepresentation> > org.keycloak.partialimport.ClientRolesPartialImport.getToOverwrite ( )

inline

                                                                 {
        return this.toOverwrite;
    }

getToSkip()

Map<String, Set<RoleRepresentation> > org.keycloak.partialimport.ClientRolesPartialImport.getToSkip ( )

inline

                                                            {
        return this.toSkip;
    }

noClientFound()

ErrorResponseException org.keycloak.partialimport.ClientRolesPartialImport.noClientFound ( String  clientId )

inlineprotected

                                                                    {
        String message = "Can not import client roles for nonexistent client named " + clientId;
        Response error = ErrorResponse.error(message, Response.Status.PRECONDITION_FAILED);
        return new ErrorResponseException(error);
    }

overwritten()

PartialImportResult org.keycloak.partialimport.ClientRolesPartialImport.overwritten ( String  clientId, String  modelId, RoleRepresentation  roleRep  )

inline

                                                                                                        {
        return PartialImportResult.overwritten(getResourceType(), getCombinedName(clientId, roleRep), modelId, roleRep);
    }

prepare()

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

inline

                                                                                                                                               {
        Map<String, List<RoleRepresentation>> repList = getRepList(partialImportRep);
        if (repList == null || repList.isEmpty()) return;

        for (String clientId : repList.keySet()) {
            if (!clientExists(partialImportRep, realm, clientId)) {
                throw noClientFound(clientId);
            }

            toOverwrite.put(clientId, new HashSet<RoleRepresentation>());
            toSkip.put(clientId, new HashSet<RoleRepresentation>());
            for (RoleRepresentation roleRep : repList.get(clientId)) {
                if (exists(realm, session, clientId, roleRep)) {
                    switch (partialImportRep.getPolicy()) {
                        case SKIP:
                            toSkip.get(clientId).add(roleRep);
                            break;
                        case OVERWRITE:
                            toOverwrite.get(clientId).add(roleRep);
                            break;
                        default:
                            throw exists(existsMessage(clientId, roleRep));
                    }
                }
            }
        }
    }

skipped()

PartialImportResult org.keycloak.partialimport.ClientRolesPartialImport.skipped ( String  clientId, String  modelId, RoleRepresentation  roleRep  )

inline

                                                                                                    {
        return PartialImportResult.skipped(getResourceType(), getCombinedName(clientId, roleRep), modelId, roleRep);
    }

メンバ詳解

toOverwrite

final Map<String, Set<RoleRepresentation> > org.keycloak.partialimport.ClientRolesPartialImport.toOverwrite = new HashMap<>()

private

toSkip

final Map<String, Set<RoleRepresentation> > org.keycloak.partialimport.ClientRolesPartialImport.toSkip = new HashMap<>()

private

---

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

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