org.keycloak.authorization.admin.ResourceServerService クラス

org.keycloak.authorization.admin.ResourceServerService 連携図

公開メンバ関数
	ResourceServerService (AuthorizationProvider authorization, ResourceServer resourceServer, ClientModel client, AdminPermissionEvaluator auth, AdminEventBuilder adminEvent)
ResourceServer	create (boolean newClient)
Response	update (ResourceServerRepresentation server)
void	delete ()
Response	findById ()
Response	exportSettings ()
Response	importSettings (ResourceServerRepresentation rep)
ResourceSetService	getResourceSetResource ()
ScopeService	getScopeResource ()
PolicyService	getPolicyResource ()
Object	getPermissionTypeResource ()

非公開メンバ関数
void	createDefaultPermission (ResourceRepresentation resource, PolicyRepresentation policy)
PolicyRepresentation	createDefaultPolicy ()
ResourceRepresentation	createDefaultResource ()
void	audit (OperationType operation, UriInfo uriInfo, boolean newClient)

非公開変数類
final AuthorizationProvider	authorization
final AdminPermissionEvaluator	auth
final AdminEventBuilder	adminEvent
final KeycloakSession	session
ResourceServer	resourceServer
final ClientModel	client

詳解

著者

Pedro Igor

構築子と解体子

ResourceServerService()

org.keycloak.authorization.admin.ResourceServerService.ResourceServerService ( AuthorizationProvider  authorization, ResourceServer  resourceServer, ClientModel  client, AdminPermissionEvaluator  auth, AdminEventBuilder  adminEvent  )

inline

                                                                                                                                                                                      {
        this.authorization = authorization;
        this.session = authorization.getKeycloakSession();
        this.client = client;
        this.resourceServer = resourceServer;
        this.auth = auth;
        this.adminEvent = adminEvent;
    }

関数詳解

audit()

void org.keycloak.authorization.admin.ResourceServerService.audit ( OperationType  operation, UriInfo  uriInfo, boolean  newClient  )

inlineprivate

                                                                                    {
        if (newClient) {
            adminEvent.resource(ResourceType.AUTHORIZATION_RESOURCE_SERVER).operation(operation).resourcePath(uriInfo, client.getId())
                    .representation(ModelToRepresentation.toRepresentation(resourceServer, client)).success();
        } else {
            adminEvent.resource(ResourceType.AUTHORIZATION_RESOURCE_SERVER).operation(operation).resourcePath(uriInfo)
                    .representation(ModelToRepresentation.toRepresentation(resourceServer, client)).success();
        }
    }

create()

ResourceServer org.keycloak.authorization.admin.ResourceServerService.create ( boolean  newClient )

inline

                                                    {
        this.auth.realm().requireManageAuthorization();

        UserModel serviceAccount = this.session.users().getServiceAccount(client);

        if (serviceAccount == null) {
            throw new RuntimeException("Client does not have a service account.");
        }

        if (this.resourceServer == null) {
            this.resourceServer = RepresentationToModel.createResourceServer(client, session, true);
        }

        createDefaultPermission(createDefaultResource(), createDefaultPolicy());
        audit(OperationType.CREATE, session.getContext().getUri(), newClient);

        return resourceServer;
    }

createDefaultPermission()

void org.keycloak.authorization.admin.ResourceServerService.createDefaultPermission ( ResourceRepresentation  resource, PolicyRepresentation  policy  )

inlineprivate

                                                                                                       {
        ResourcePermissionRepresentation defaultPermission = new ResourcePermissionRepresentation();

        defaultPermission.setName("Default Permission");
        defaultPermission.setDescription("A permission that applies to the default resource type");
        defaultPermission.setDecisionStrategy(DecisionStrategy.UNANIMOUS);
        defaultPermission.setLogic(Logic.POSITIVE);

        defaultPermission.setResourceType(resource.getType());
        defaultPermission.addPolicy(policy.getName());

        getPolicyResource().create(defaultPermission);
    }

createDefaultPolicy()

PolicyRepresentation org.keycloak.authorization.admin.ResourceServerService.createDefaultPolicy ( )

inlineprivate

                                                       {
        PolicyRepresentation defaultPolicy = new PolicyRepresentation();

        defaultPolicy.setName("Default Policy");
        defaultPolicy.setDescription("A policy that grants access only for users within this realm");
        defaultPolicy.setType("js");
        defaultPolicy.setDecisionStrategy(DecisionStrategy.AFFIRMATIVE);
        defaultPolicy.setLogic(Logic.POSITIVE);

        HashMap<String, String> defaultPolicyConfig = new HashMap<>();

        defaultPolicyConfig.put("code", "// by default, grants any permission associated with this policy\n$evaluation.grant();\n");

        defaultPolicy.setConfig(defaultPolicyConfig);

        getPolicyResource().create(defaultPolicy);

        return defaultPolicy;
    }

createDefaultResource()

ResourceRepresentation org.keycloak.authorization.admin.ResourceServerService.createDefaultResource ( )

inlineprivate

                                                           {
        ResourceRepresentation defaultResource = new ResourceRepresentation();

        defaultResource.setName("Default Resource");
        defaultResource.setUris(Collections.singleton("/*"));
        defaultResource.setType("urn:" + this.client.getClientId() + ":resources:default");

        getResourceSetResource().create(defaultResource);
        return defaultResource;
    }

delete()

void org.keycloak.authorization.admin.ResourceServerService.delete ( )

inline

                         {
        this.auth.realm().requireManageAuthorization();
        authorization.getStoreFactory().getResourceServerStore().delete(resourceServer.getId());
        audit(OperationType.DELETE, session.getContext().getUri(), false);
    }

exportSettings()

Response org.keycloak.authorization.admin.ResourceServerService.exportSettings ( )

inline

                                     {
        this.auth.realm().requireManageAuthorization();
        return Response.ok(ExportUtils.exportAuthorizationSettings(session, client)).build();
    }

findById()

Response org.keycloak.authorization.admin.ResourceServerService.findById ( )

inline

                               {
        this.auth.realm().requireViewAuthorization();
        return Response.ok(toRepresentation(this.resourceServer, this.client)).build();
    }

getPermissionTypeResource()

Object org.keycloak.authorization.admin.ResourceServerService.getPermissionTypeResource ( )

inline

                                              {
        this.auth.realm().requireViewAuthorization();
        PermissionService resource = new PermissionService(this.resourceServer, this.authorization, this.auth, adminEvent);

        ResteasyProviderFactory.getInstance().injectProperties(resource);

        return resource;
    }

getPolicyResource()

PolicyService org.keycloak.authorization.admin.ResourceServerService.getPolicyResource ( )

inline

                                             {
        PolicyService resource = new PolicyService(this.resourceServer, this.authorization, this.auth, adminEvent);

        ResteasyProviderFactory.getInstance().injectProperties(resource);

        return resource;
    }

getResourceSetResource()

ResourceSetService org.keycloak.authorization.admin.ResourceServerService.getResourceSetResource ( )

inline

                                                       {
        ResourceSetService resource = new ResourceSetService(this.session, this.resourceServer, this.authorization, this.auth, adminEvent);

        ResteasyProviderFactory.getInstance().injectProperties(resource);

        return resource;
    }

getScopeResource()

ScopeService org.keycloak.authorization.admin.ResourceServerService.getScopeResource ( )

inline

                                           {
        ScopeService resource = new ScopeService(this.session, this.resourceServer, this.authorization, this.auth, adminEvent);

        ResteasyProviderFactory.getInstance().injectProperties(resource);

        return resource;
    }

importSettings()

Response org.keycloak.authorization.admin.ResourceServerService.importSettings ( ResourceServerRepresentation  rep )

inline

                                                                     {
        this.auth.realm().requireManageAuthorization();

        rep.setClientId(client.getId());

        RepresentationToModel.toModel(rep, authorization);

        audit(OperationType.UPDATE, session.getContext().getUri(), false);

        return Response.noContent().build();
    }

update()

Response org.keycloak.authorization.admin.ResourceServerService.update ( ResourceServerRepresentation  server )

inline

                                                                {
        this.auth.realm().requireManageAuthorization();
        this.resourceServer.setAllowRemoteResourceManagement(server.isAllowRemoteResourceManagement());
        this.resourceServer.setPolicyEnforcementMode(server.getPolicyEnforcementMode());
        audit(OperationType.UPDATE, session.getContext().getUri(), false);
        return Response.noContent().build();
    }

メンバ詳解

adminEvent

final AdminEventBuilder org.keycloak.authorization.admin.ResourceServerService.adminEvent

private

auth

final AdminPermissionEvaluator org.keycloak.authorization.admin.ResourceServerService.auth

private

authorization

final AuthorizationProvider org.keycloak.authorization.admin.ResourceServerService.authorization

private

client

final ClientModel org.keycloak.authorization.admin.ResourceServerService.client

private

resourceServer

ResourceServer org.keycloak.authorization.admin.ResourceServerService.resourceServer

private

session

final KeycloakSession org.keycloak.authorization.admin.ResourceServerService.session

private

---

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

• D:/AppData/doxygen/keycloak/oidc-service/src/main/java/org/keycloak/authorization/admin/ResourceServerService.java