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

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

公開メンバ関数
	ScopeMappedClientResource (RealmModel realm, AdminPermissionEvaluator auth, ScopeContainerModel scopeContainer, KeycloakSession session, ClientModel scopedClient, AdminEventBuilder adminEvent, AdminPermissionEvaluator.RequirePermissionCheck managePermission, AdminPermissionEvaluator.RequirePermissionCheck viewPermission)
List< RoleRepresentation >	getClientScopeMappings ()
List< RoleRepresentation >	getAvailableClientScopeMappings ()
List< RoleRepresentation >	getCompositeClientScopeMappings ()
void	addClientScopeMapping (List< RoleRepresentation > roles)
void	deleteClientScopeMapping (List< RoleRepresentation > roles)

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

詳解

Scope Mappings

著者

Bill Burke

バージョン

Revision

1

構築子と解体子

ScopeMappedClientResource()

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

inline

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

関数詳解

addClientScopeMapping()

void org.keycloak.services.resources.admin.ScopeMappedClientResource.addClientScopeMapping ( List< RoleRepresentation >  roles )

inline

Add client-level roles to the client's scope

引数

roles

                                                                      {
        managePermission.require();

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

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

deleteClientScopeMapping()

void org.keycloak.services.resources.admin.ScopeMappedClientResource.deleteClientScopeMapping ( List< RoleRepresentation >  roles )

inline

Remove client-level roles from the client's scope.

引数

roles

                                                                         {
        managePermission.require();

        if (roles == null) {
            Set<RoleModel> roleModels = KeycloakModelUtils.getClientScopeMappings(scopedClient, scopeContainer);//scopedClient.getClientScopeMappings(client);
            roles = new LinkedList<>();

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

        } else {
            for (RoleRepresentation role : roles) {
                RoleModel roleModel = scopedClient.getRole(role.getName());
                if (roleModel == null) {
                    throw new NotFoundException("Role not found");
                }
                scopeContainer.deleteScopeMapping(roleModel);
            }
        }

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

getAvailableClientScopeMappings()

List<RoleRepresentation> org.keycloak.services.resources.admin.ScopeMappedClientResource.getAvailableClientScopeMappings ( )

inline

The available client-level roles

Returns the roles for the client that can be associated with the client's scope

戻り値

                                                                      {
        viewPermission.require();

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

getClientScopeMappings()

List<RoleRepresentation> org.keycloak.services.resources.admin.ScopeMappedClientResource.getClientScopeMappings ( )

inline

Get the roles associated with a client's scope

Returns roles for the client.

戻り値

                                                             {
        viewPermission.require();

        Set<RoleModel> mappings = KeycloakModelUtils.getClientScopeMappings(scopedClient, scopeContainer); //scopedClient.getClientScopeMappings(client);
        List<RoleRepresentation> mapRep = new ArrayList<RoleRepresentation>();
        for (RoleModel roleModel : mappings) {
            mapRep.add(ModelToRepresentation.toRepresentation(roleModel));
        }
        return mapRep;
    }

getCompositeClientScopeMappings()

List<RoleRepresentation> org.keycloak.services.resources.admin.ScopeMappedClientResource.getCompositeClientScopeMappings ( )

inline

Get effective client roles

Returns the roles for the client that are associated with the client's scope.

戻り値

                                                                      {
        viewPermission.require();

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

メンバ詳解

adminEvent

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

protected

auth

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

protected

managePermission

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

protected

realm

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

protected

scopeContainer

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

protected

scopedClient

ClientModel org.keycloak.services.resources.admin.ScopeMappedClientResource.scopedClient

protected

session

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

protected

viewPermission

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

protected

---

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

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