org.keycloak.services.resources.admin.ScopeMappedResource クラス

org.keycloak.services.resources.admin.ScopeMappedResource 連携図

公開メンバ関数
	ScopeMappedResource (RealmModel realm, AdminPermissionEvaluator auth, ScopeContainerModel scopeContainer, KeycloakSession session, AdminEventBuilder adminEvent, AdminPermissionEvaluator.RequirePermissionCheck managePermission, AdminPermissionEvaluator.RequirePermissionCheck viewPermission)
MappingsRepresentation	getScopeMappings ()
List< RoleRepresentation >	getRealmScopeMappings ()
List< RoleRepresentation >	getAvailableRealmScopeMappings ()
List< RoleRepresentation >	getCompositeRealmScopeMappings ()
void	addRealmScopeMappings (List< RoleRepresentation > roles)
void	deleteRealmScopeMappings (List< RoleRepresentation > roles)
ScopeMappedClientResource	getClientByIdScopeMappings (@PathParam("client") String client)

静的公開メンバ関数
static List< RoleRepresentation >	getAvailable (AdminPermissionEvaluator auth, ScopeContainerModel client, Set< RoleModel > roles)
static List< RoleRepresentation >	getComposite (ScopeContainerModel client, Set< RoleModel > roles)

限定公開変数類
RealmModel	realm
AdminPermissionEvaluator	auth
AdminPermissionEvaluator.RequirePermissionCheck	managePermission
AdminPermissionEvaluator.RequirePermissionCheck	viewPermission
ScopeContainerModel	scopeContainer
KeycloakSession	session
AdminEventBuilder	adminEvent

詳解

Base class for managing the scope mappings of a specific client.

Scope Mappings

著者

Bill Burke

バージョン

Revision

1

構築子と解体子

ScopeMappedResource()

org.keycloak.services.resources.admin.ScopeMappedResource.ScopeMappedResource ( RealmModel  realm, AdminPermissionEvaluator  auth, ScopeContainerModel  scopeContainer, KeycloakSession  session, AdminEventBuilder  adminEvent, AdminPermissionEvaluator.RequirePermissionCheck  managePermission, AdminPermissionEvaluator.RequirePermissionCheck  viewPermission  )

inline

                                                                                               {
        this.realm = realm;
        this.auth = auth;
        this.scopeContainer = scopeContainer;
        this.session = session;
        this.adminEvent = adminEvent.resource(ResourceType.REALM_SCOPE_MAPPING);
        this.managePermission = managePermission;
        this.viewPermission = viewPermission;
    }

関数詳解

addRealmScopeMappings()

void org.keycloak.services.resources.admin.ScopeMappedResource.addRealmScopeMappings ( List< RoleRepresentation >  roles )

inline

Add a set of realm-level roles to the client's scope

引数

roles

                                                                      {
        managePermission.require();

        if (scopeContainer == null) {
            throw new NotFoundException("Could not find client");
        }

        for (RoleRepresentation role : roles) {
            RoleModel roleModel = realm.getRoleById(role.getId());
            if (roleModel == null) {
                throw new NotFoundException("Role not found");
            }
            scopeContainer.addScopeMapping(roleModel);
        }

        adminEvent.operation(OperationType.CREATE).resourcePath(session.getContext().getUri()).representation(roles).success();
    }

deleteRealmScopeMappings()

void org.keycloak.services.resources.admin.ScopeMappedResource.deleteRealmScopeMappings ( List< RoleRepresentation >  roles )

inline

Remove a set of realm-level roles from the client's scope

引数

roles

                                                                         {
        managePermission.require();

        if (scopeContainer == null) {
            throw new NotFoundException("Could not find client");
        }

        if (roles == null) {
            Set<RoleModel> roleModels = scopeContainer.getRealmScopeMappings();
            roles = new LinkedList<>();

            for (RoleModel roleModel : roleModels) {
                scopeContainer.deleteScopeMapping(roleModel);
                roles.add(ModelToRepresentation.toRepresentation(roleModel));
            }

       } else {
            for (RoleRepresentation role : roles) {
                RoleModel roleModel = realm.getRoleById(role.getId());
                if (roleModel == null) {
                    throw new NotFoundException("Client not found");
                }
                scopeContainer.deleteScopeMapping(roleModel);
            }
        }

        adminEvent.operation(OperationType.DELETE).resourcePath(session.getContext().getUri()).representation(roles).success();

    }

getAvailable()

static List<RoleRepresentation> org.keycloak.services.resources.admin.ScopeMappedResource.getAvailable ( AdminPermissionEvaluator  auth, ScopeContainerModel  client, Set< RoleModel >  roles  )

inlinestatic

                                                                                                                                         {
        List<RoleRepresentation> available = new ArrayList<RoleRepresentation>();
        for (RoleModel roleModel : roles) {
            if (client.hasScope(roleModel)) continue;
            if (!auth.roles().canMapClientScope(roleModel)) continue;
            available.add(ModelToRepresentation.toRepresentation(roleModel));
        }
        return available;
    }

getAvailableRealmScopeMappings()

List<RoleRepresentation> org.keycloak.services.resources.admin.ScopeMappedResource.getAvailableRealmScopeMappings ( )

inline

Get realm-level roles that are available to attach to this client's scope

戻り値

                                                                     {
        viewPermission.require();

        if (scopeContainer == null) {
            throw new NotFoundException("Could not find client");
        }

        Set<RoleModel> roles = realm.getRoles();
        return getAvailable(auth, scopeContainer, roles);
    }

getClientByIdScopeMappings()

ScopeMappedClientResource org.keycloak.services.resources.admin.ScopeMappedResource.getClientByIdScopeMappings ( @PathParam("client") String  client )

inline

                                                                                                    {
        ClientModel clientModel = realm.getClientById(client);
        if (clientModel == null) {
            throw new NotFoundException("Could not find client");
        }
        return new ScopeMappedClientResource(realm, auth, this.scopeContainer, session, clientModel, adminEvent, managePermission, viewPermission);
    }

getComposite()

static List<RoleRepresentation> org.keycloak.services.resources.admin.ScopeMappedResource.getComposite ( ScopeContainerModel  client, Set< RoleModel >  roles  )

inlinestatic

                                                                                                          {
        List<RoleRepresentation> composite = new ArrayList<RoleRepresentation>();
        for (RoleModel roleModel : roles) {
            if (client.hasScope(roleModel)) composite.add(ModelToRepresentation.toRepresentation(roleModel));
        }
        return composite;
    }

getCompositeRealmScopeMappings()

List<RoleRepresentation> org.keycloak.services.resources.admin.ScopeMappedResource.getCompositeRealmScopeMappings ( )

inline

Get effective realm-level roles associated with the client's scope

What this does is recurse any composite roles associated with the client's scope and adds the roles to this lists. The method is really to show a comprehensive total view of realm-level roles associated with the client.

戻り値

                                                                     {
        viewPermission.require();

        if (scopeContainer == null) {
            throw new NotFoundException("Could not find client");
        }

        Set<RoleModel> roles = realm.getRoles();
        return getComposite(scopeContainer, roles);
    }

getRealmScopeMappings()

List<RoleRepresentation> org.keycloak.services.resources.admin.ScopeMappedResource.getRealmScopeMappings ( )

inline

Get realm-level roles associated with the client's scope

戻り値

                                                            {
        viewPermission.require();

        if (scopeContainer == null) {
            throw new NotFoundException("Could not find client");
        }

        Set<RoleModel> realmMappings = scopeContainer.getRealmScopeMappings();
        List<RoleRepresentation> realmMappingsRep = new ArrayList<RoleRepresentation>();
        for (RoleModel roleModel : realmMappings) {
            realmMappingsRep.add(ModelToRepresentation.toRepresentation(roleModel));
        }
        return realmMappingsRep;
    }

getScopeMappings()

MappingsRepresentation org.keycloak.services.resources.admin.ScopeMappedResource.getScopeMappings ( )

inline

Get all scope mappings for the client

戻り値

                                                     {
        viewPermission.require();

        if (scopeContainer == null) {
            throw new NotFoundException("Could not find client");
        }

        MappingsRepresentation all = new MappingsRepresentation();
        Set<RoleModel> realmMappings = scopeContainer.getRealmScopeMappings();
        if (realmMappings.size() > 0) {
            List<RoleRepresentation> realmRep = new ArrayList<RoleRepresentation>();
            for (RoleModel roleModel : realmMappings) {
                realmRep.add(ModelToRepresentation.toRepresentation(roleModel));
            }
            all.setRealmMappings(realmRep);
        }

        List<ClientModel> clients = realm.getClients();
        if (clients.size() > 0) {
            Map<String, ClientMappingsRepresentation> clientMappings = new HashMap<String, ClientMappingsRepresentation>();
            for (ClientModel client : clients) {
                Set<RoleModel> roleMappings = KeycloakModelUtils.getClientScopeMappings(client, this.scopeContainer); //client.getClientScopeMappings(this.client);
                if (roleMappings.size() > 0) {
                    ClientMappingsRepresentation mappings = new ClientMappingsRepresentation();
                    mappings.setId(client.getId());
                    mappings.setClient(client.getClientId());
                    List<RoleRepresentation> roles = new ArrayList<RoleRepresentation>();
                    mappings.setMappings(roles);
                    for (RoleModel role : roleMappings) {
                        roles.add(ModelToRepresentation.toRepresentation(role));
                    }
                    clientMappings.put(client.getClientId(), mappings);
                    all.setClientMappings(clientMappings);
                }
            }
        }
        return all;
    }

メンバ詳解

adminEvent

AdminEventBuilder org.keycloak.services.resources.admin.ScopeMappedResource.adminEvent

protected

auth

AdminPermissionEvaluator org.keycloak.services.resources.admin.ScopeMappedResource.auth

protected

managePermission

AdminPermissionEvaluator.RequirePermissionCheck org.keycloak.services.resources.admin.ScopeMappedResource.managePermission

protected

realm

RealmModel org.keycloak.services.resources.admin.ScopeMappedResource.realm

protected

scopeContainer

ScopeContainerModel org.keycloak.services.resources.admin.ScopeMappedResource.scopeContainer

protected

session

KeycloakSession org.keycloak.services.resources.admin.ScopeMappedResource.session

protected

viewPermission

AdminPermissionEvaluator.RequirePermissionCheck org.keycloak.services.resources.admin.ScopeMappedResource.viewPermission

protected

---

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

• D:/AppData/doxygen/keycloak/rest-service/src/services/src/main/java/org/keycloak/services/resources/admin/ScopeMappedResource.java